Skip to main content

PackagedProductDefinition

PropertyValue
Publisher
NamePackagedProductDefinition
URLhttp://hl7.org/fhir/StructureDefinition/PackagedProductDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
PackagedProductDefinition0..*PackagedProductDefinitionA medically related item or items, in a container or package.
PackagedProductDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
PackagedProductDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
PackagedProductDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
PackagedProductDefinition.language0..1codeThe base language in which the resource is written.
PackagedProductDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
PackagedProductDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
PackagedProductDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PackagedProductDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PackagedProductDefinition.identifier0..*IdentifierA unique identifier for this package as whole. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.
PackagedProductDefinition.name0..1stringA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
PackagedProductDefinition.type0..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping/transport container, etc.
PackagedProductDefinition.packageFor0..*ReferenceThe product that this is a pack for.
PackagedProductDefinition.status0..1CodeableConceptThe 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.
PackagedProductDefinition.statusDate0..1dateTimeThe date at which the given status became applicable.
PackagedProductDefinition.containedItemQuantity0..*QuantityA 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.
PackagedProductDefinition.description0..1markdownTextual description. Note that this is not the name of the package or product.
PackagedProductDefinition.legalStatusOfSupply0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator.
PackagedProductDefinition.legalStatusOfSupply.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PackagedProductDefinition.legalStatusOfSupply.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PackagedProductDefinition.legalStatusOfSupply.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PackagedProductDefinition.legalStatusOfSupply.code0..1CodeableConceptThe actual status of supply. Conveys in what situation this package type may be supplied for use.
PackagedProductDefinition.legalStatusOfSupply.jurisdiction0..1CodeableConceptThe place where the legal status of supply applies. When not specified, this indicates it is unknown in this context.
PackagedProductDefinition.marketingStatus0..*MarketingStatusAllows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.
PackagedProductDefinition.characteristic0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".
PackagedProductDefinition.copackagedIndicator0..1booleanStates whether a drug product is supplied with another item such as a diluent or adjuvant.
PackagedProductDefinition.manufacturer0..*ReferenceManufacturer of this package type. When there are multiple it means these are all possible manufacturers.
PackagedProductDefinition.package0..1BackboneElementA 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).
PackagedProductDefinition.package.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PackagedProductDefinition.package.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PackagedProductDefinition.package.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PackagedProductDefinition.package.identifier0..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly Data Carrier Identifier (a GS1 barcode).
PackagedProductDefinition.package.type0..1CodeableConceptThe physical type of the container of the items.
PackagedProductDefinition.package.quantity0..1integerThe quantity of this level of packaging in the package that contains it. If specified, the outermost level is always 1.
PackagedProductDefinition.package.material0..*CodeableConceptMaterial type of the package item.
PackagedProductDefinition.package.alternateMaterial0..*CodeableConceptA 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).
PackagedProductDefinition.package.shelfLifeStorage0..*BackboneElementShelf Life and storage information.
PackagedProductDefinition.package.shelfLifeStorage.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PackagedProductDefinition.package.shelfLifeStorage.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PackagedProductDefinition.package.shelfLifeStorage.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PackagedProductDefinition.package.shelfLifeStorage.type0..1CodeableConceptThis describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.
PackagedProductDefinition.package.shelfLifeStorage.period[x]0..1DurationThe shelf life time period can be specified using a numerical value for the period of time and its unit of time 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.
PackagedProductDefinition.package.shelfLifeStorage.specialPrecautionsForStorage0..*CodeableConceptSpecial precautions for storage, if any, can be specified using an appropriate controlled vocabulary. The controlled term and the controlled term identifier shall be specified.
PackagedProductDefinition.package.manufacturer0..*ReferenceManufacturer of this package Item. When there are multiple it means these are all possible manufacturers.
PackagedProductDefinition.package.property0..*BackboneElementGeneral characteristics of this item.
PackagedProductDefinition.package.property.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PackagedProductDefinition.package.property.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PackagedProductDefinition.package.property.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PackagedProductDefinition.package.property.type1..1CodeableConceptA code expressing the type of characteristic.
PackagedProductDefinition.package.property.value[x]0..1CodeableConceptA value for the characteristic.
PackagedProductDefinition.package.containedItem0..*BackboneElementThe item(s) within the packaging.
PackagedProductDefinition.package.containedItem.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PackagedProductDefinition.package.containedItem.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PackagedProductDefinition.package.containedItem.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
PackagedProductDefinition.package.containedItem.item1..1CodeableReferenceThe actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package).
PackagedProductDefinition.package.containedItem.amount0..1QuantityThe number of this type of item within this packaging.
PackagedProductDefinition.package.package0..*PackagedProductDefinitionAllows containers (and parts of containers) parwithin containers, still a single packaged product. See also PackagedProductDefinition.package.containedItem.item(PackagedProductDefinition).

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
biologicalreferenceA biologically derived product within this packaged productPackagedProductDefinition.package.containedItem.item.reference
contained-itemreferenceAny of the contained items within this packaged productPackagedProductDefinition.package.containedItem.item.reference
devicereferenceA device within this packaged productPackagedProductDefinition.package.containedItem.item.reference
identifiertokenUnique identifierPackagedProductDefinition.identifier
manufactured-itemreferenceA manufactured item of medication within this packaged productPackagedProductDefinition.package.containedItem.item.reference
medicationreferenceA manufactured item of medication within this packaged productPackagedProductDefinition.package.containedItem.item.reference
nametokenA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etcPackagedProductDefinition.name
nutritionreferenceA nutrition product within this packaged productPackagedProductDefinition.package.containedItem.item.reference
packagereferenceA complete packaged product within this packaged productPackagedProductDefinition.package.containedItem.item.reference
package-forreferenceThe product that this is a pack forPackagedProductDefinition.packageFor
statustokenThe 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 statusPackagedProductDefinition.status