Data Model Libraries
    Preparing search index...

    Class PackagedProductDefinitionPackagingComponent

    PackagedProductDefinitionPackagingComponent Class

    FHIR Specification

    • Short: A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
    • Definition: 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).

    FHIR PackagedProductDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? type_? componentPart? quantity? material? alternateMaterial? shelfLifeStorage? manufacturer? property? containedItem? packaging?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getType setType hasType getComponentPartElement setComponentPartElement hasComponentPartElement getComponentPart setComponentPart hasComponentPart getQuantityElement setQuantityElement hasQuantityElement getQuantity setQuantity hasQuantity getMaterial setMaterial addMaterial hasMaterial getAlternateMaterial setAlternateMaterial addAlternateMaterial hasAlternateMaterial getShelfLifeStorage setShelfLifeStorage addShelfLifeStorage hasShelfLifeStorage getManufacturer setManufacturer addManufacturer hasManufacturer getProperty setProperty addProperty hasProperty getContainedItem setContainedItem addContainedItem hasContainedItem getPackaging setPackaging addPackaging hasPackaging fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initMaterial initAlternateMaterial initShelfLifeStorage initManufacturer initProperty initContainedItem initPackaging

    Constructors

    Properties

    identifier?: Identifier[]

    PackagedProductDefinition.packaging.identifier Element

    FHIR Specification

    • Short: An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
    • Definition: A business identifier that is specific to this particular part of the packaging, often assigned by the manufacturer. Including possibly Data Carrier Identifier (a GS1 barcode).
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    PackagedProductDefinition.packaging.type Element

    FHIR Specification

    • Short: The physical type of the container of the items
    • Definition: The physical type of the container of the items.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    componentPart?: BooleanType

    PackagedProductDefinition.packaging.componentPart Element

    FHIR Specification

    • Short: Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial)
    • Definition: Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial). The latter type are designed be a container, but the former are not.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    quantity?: IntegerType

    PackagedProductDefinition.packaging.quantity Element

    FHIR Specification

    • Short: The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
    • Definition: The quantity of packaging items contained at this layer of the package. This does not relate to the number of contained items but relates solely to the number of packaging items. When looking at the outermost layer it is always 1. If there are two boxes within, at the next layer it would be 2.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    material?: CodeableConcept[]

    PackagedProductDefinition.packaging.material Element

    FHIR Specification

    • Short: Material type of the package item
    • Definition: Material type of the package item.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    alternateMaterial?: CodeableConcept[]

    PackagedProductDefinition.packaging.alternateMaterial Element

    FHIR Specification

    • Short: A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
    • Definition: A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material (e.g. different types of plastic for a blister sleeve).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    shelfLifeStorage?: ProductShelfLife[]

    PackagedProductDefinition.packaging.shelfLifeStorage Element

    FHIR Specification

    • Short: Shelf Life and storage information
    • Definition: Shelf Life and storage information.
    • FHIR Type: ProductShelfLife
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    manufacturer?: Reference[]

    PackagedProductDefinition.packaging.manufacturer Element

    FHIR Specification

    • Short: Manufacturer of this packaging item (multiple means these are all potential manufacturers)
    • Definition: Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging item.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    property?: PackagedProductDefinitionPackagingPropertyComponent[]

    PackagedProductDefinition.packaging.property Element

    FHIR Specification

    • Short: General characteristics of this item
    • Definition: General characteristics of this item.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    containedItem?: PackagedProductDefinitionPackagingContainedItemComponent[]

    PackagedProductDefinition.packaging.containedItem Element

    FHIR Specification

    • Short: The item(s) within the packaging
    • Definition: The item(s) within the packaging.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    packaging?: PackagedProductDefinitionPackagingComponent[]

    PackagedProductDefinition.packaging.packaging Element

    FHIR Specification

    • Short: Allows containers (and parts of containers) within containers, still as a part of single packaged product
    • Definition: Allows containers (and parts of containers) within containers, still as a part of a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided PackagedProductDefinitionPackagingComponent JSON to instantiate the PackagedProductDefinitionPackagingComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR PackagedProductDefinitionPackagingComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PackagedProductDefinitionPackagingComponent

      Returns undefined | PackagedProductDefinitionPackagingComponent

      PackagedProductDefinitionPackagingComponent data model or undefined for PackagedProductDefinitionPackagingComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetTypesetTypehasTypegetComponentPartElementsetComponentPartElementhasComponentPartElementgetComponentPartsetComponentParthasComponentPartgetQuantityElementsetQuantityElementhasQuantityElementgetQuantitysetQuantityhasQuantitygetMaterialsetMaterialaddMaterialhasMaterialgetAlternateMaterialsetAlternateMaterialaddAlternateMaterialhasAlternateMaterialgetShelfLifeStoragesetShelfLifeStorageaddShelfLifeStoragehasShelfLifeStoragegetManufacturersetManufactureraddManufacturerhasManufacturergetPropertysetPropertyaddPropertyhasPropertygetContainedItemsetContainedItemaddContainedItemhasContainedItemgetPackagingsetPackagingaddPackaginghasPackagingfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitMaterialinitAlternateMaterialinitShelfLifeStorageinitManufacturerinitPropertyinitContainedIteminitPackaging