Data Model Libraries
    Preparing search index...

    Class PackagedProductDefinition

    PackagedProductDefinition Class

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

    FHIR Specification

    • Short: A medically related item or items, in a container or package
    • Definition: A medically related item or items, in a container or package.
    • FHIR Version: 5.0.0

    FHIR PackagedProductDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? name? type_? packageFor? status? statusDate? containedItemQuantity? description? legalStatusOfSupply? marketingStatus? copackagedIndicator? manufacturer? attachedDocument? packaging? characteristic?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getNameElement setNameElement hasNameElement getName setName hasName getType setType hasType getPackageFor setPackageFor addPackageFor hasPackageFor getStatus setStatus hasStatus getStatusDateElement setStatusDateElement hasStatusDateElement getStatusDate setStatusDate hasStatusDate getContainedItemQuantity setContainedItemQuantity addContainedItemQuantity hasContainedItemQuantity getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getLegalStatusOfSupply setLegalStatusOfSupply addLegalStatusOfSupply hasLegalStatusOfSupply getMarketingStatus setMarketingStatus addMarketingStatus hasMarketingStatus getCopackagedIndicatorElement setCopackagedIndicatorElement hasCopackagedIndicatorElement getCopackagedIndicator setCopackagedIndicator hasCopackagedIndicator getManufacturer setManufacturer addManufacturer hasManufacturer getAttachedDocument setAttachedDocument addAttachedDocument hasAttachedDocument getPackaging setPackaging hasPackaging getCharacteristic setCharacteristic addCharacteristic hasCharacteristic fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initPackageFor initContainedItemQuantity initLegalStatusOfSupply initMarketingStatus initManufacturer initAttachedDocument initCharacteristic

    Constructors

    Properties

    identifier?: Identifier[]

    PackagedProductDefinition.identifier Element

    FHIR Specification

    • Short: A unique identifier for this package as whole - not for the content of the package
    • Definition: 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.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    PackagedProductDefinition.name Element

    FHIR Specification

    • Short: A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
    • Definition: A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    PackagedProductDefinition.type Element

    FHIR Specification

    • Short: A high level category e.g. medicinal product, raw material, shipping container etc
    • Definition: A high level category e.g. medicinal product, raw material, shipping/transport container, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    packageFor?: Reference[]

    PackagedProductDefinition.packageFor Element

    FHIR Specification

    • Short: The product that this is a pack for
    • Definition: The product this package model relates to, not the contents of the package (for which see package.containedItem).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    status?: CodeableConcept

    PackagedProductDefinition.status Element

    FHIR Specification

    • Short: The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true
    statusDate?: DateTimeType

    PackagedProductDefinition.statusDate Element

    FHIR Specification

    • Short: The date at which the given status became applicable
    • Definition: The date at which the given status became applicable.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    containedItemQuantity?: Quantity[]

    PackagedProductDefinition.containedItemQuantity Element

    FHIR Specification

    • Short: 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. See also packaging.containedItem.amount (especially the long definition)
    • Definition: 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.
    • FHIR Type: Quantity
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    PackagedProductDefinition.description Element

    FHIR Specification

    • Short: Textual description. Note that this is not the name of the package or product
    • Definition: Textual description. Note that this is not the name of the package or product.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    legalStatusOfSupply?: PackagedProductDefinitionLegalStatusOfSupplyComponent[]

    PackagedProductDefinition.legalStatusOfSupply Element

    FHIR Specification

    • Short: The legal status of supply of the packaged item as classified by the regulator
    • Definition: The legal status of supply of the packaged item as classified by the regulator.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    marketingStatus?: MarketingStatus[]

    PackagedProductDefinition.marketingStatus Element

    FHIR Specification

    • Short: Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
    • Definition: Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.
    • FHIR Type: MarketingStatus
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    copackagedIndicator?: BooleanType

    PackagedProductDefinition.copackagedIndicator Element

    FHIR Specification

    • Short: Identifies if the drug product is supplied with another item such as a diluent or adjuvant
    • Definition: Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    manufacturer?: Reference[]

    PackagedProductDefinition.manufacturer Element

    FHIR Specification

    • Short: Manufacturer of this package type (multiple means these are all possible manufacturers)
    • Definition: Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    attachedDocument?: Reference[]

    PackagedProductDefinition.attachedDocument Element

    FHIR Specification

    • Short: Additional information or supporting documentation about the packaged product
    • Definition: Additional information or supporting documentation about the packaged product.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    packaging?: PackagedProductDefinitionPackagingComponent

    PackagedProductDefinition.packaging Element

    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 Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    characteristic?: PackagedProductDefinitionPackagingPropertyComponent[]

    PackagedProductDefinition.characteristic Element

    FHIR Specification

    • Short: Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
    • Definition: Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PackagedProductDefinition

      • OptionaloptSourceField: string

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

      Returns undefined | PackagedProductDefinition

      PackagedProductDefinition data model or undefined for PackagedProductDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTypesetTypehasTypegetPackageForsetPackageForaddPackageForhasPackageForgetStatussetStatushasStatusgetStatusDateElementsetStatusDateElementhasStatusDateElementgetStatusDatesetStatusDatehasStatusDategetContainedItemQuantitysetContainedItemQuantityaddContainedItemQuantityhasContainedItemQuantitygetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetLegalStatusOfSupplysetLegalStatusOfSupplyaddLegalStatusOfSupplyhasLegalStatusOfSupplygetMarketingStatussetMarketingStatusaddMarketingStatushasMarketingStatusgetCopackagedIndicatorElementsetCopackagedIndicatorElementhasCopackagedIndicatorElementgetCopackagedIndicatorsetCopackagedIndicatorhasCopackagedIndicatorgetManufacturersetManufactureraddManufacturerhasManufacturergetAttachedDocumentsetAttachedDocumentaddAttachedDocumenthasAttachedDocumentgetPackagingsetPackaginghasPackaginggetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitPackageForinitContainedItemQuantityinitLegalStatusOfSupplyinitMarketingStatusinitManufacturerinitAttachedDocumentinitCharacteristic