Guia de Implementação do AnHealth
0.2.0 - CI Build

Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: PackagedProductDefinition

Official URL: https://ancode.app/fhir/StructureDefinition/PackagedProductDefinition Version: 0.2.0
Draft as of 2023-08-28 Computable Name: PackagedProductDefinition

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... packageConversionFactor 0..*(Complex)Extension
URL: https://ancode.app/fhir/StructureDefinition/PackageConversionFactor
... status ?!Σ0..1CodeableConceptThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPackagedProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPackagedProductDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPackagedProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPackagedProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePackagedProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... packageConversionFactor 0..*(Complex)Extension
URL: https://ancode.app/fhir/StructureDefinition/PackageConversionFactor
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA unique identifier for this package as whole
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
... type Σ0..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping container etc
Binding: PackageType (example): A high level categorisation of a package.

... packageFor Σ0..*Reference(MedicinalProductDefinition)The product that this is a pack for
... status ?!Σ0..1CodeableConceptThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... containedItemQuantity Σ0..*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
... description Σ0..1markdownTextual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Binding: Jurisdiction ValueSet (example): Jurisdiction codes

... marketingStatus Σ0..*MarketingStatusAllows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
Binding: PackageCharacteristic (example): A characteristic of a package.


... copackagedIndicator Σ0..1booleanIf the drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ0..*Reference(Organization)Manufacturer of this package type (multiple means these are all possible manufacturers)
... package Σ0..1BackboneElementA packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
.... type Σ0..1CodeableConceptThe physical type of the container of the items
Binding: PackagingType (example): A high level categorisation of a package.

.... quantity Σ0..1integerThe quantity of this level of packaging in the package that contains it (with the outermost level being 1)
.... material Σ0..*CodeableConceptMaterial type of the package item
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... shelfLifeStorage Σ0..*BackboneElementShelf Life and storage information
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..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
..... period[x] Σ0..1The 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
...... periodDurationDuration
...... periodStringstring
..... specialPrecautionsForStorage Σ0..*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
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this package Item (multiple means these are all possible manufacturers)
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptA code expressing the type of characteristic
Binding: product-characteristic-codes (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... item Σ1..1CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct)The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
..... amount Σ0..1QuantityThe number of this type of item within this packaging
.... package Σ0..*See package (PackagedProductDefinition)Allows containers (and parts of containers) within containers, still a single packaged product

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PackagedProductDefinition.typeexamplePackageType
PackagedProductDefinition.statuspreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.codeexampleLegalStatusOfSupply
PackagedProductDefinition.legalStatusOfSupply.jurisdictionexampleJurisdiction ValueSet
PackagedProductDefinition.characteristicexamplePackageCharacteristic
PackagedProductDefinition.package.typeexamplePackagingType
PackagedProductDefinition.package.materialexamplePackageMaterial
PackagedProductDefinition.package.alternateMaterialexamplePackageMaterial
PackagedProductDefinition.package.property.typeexamplehttp://hl7.org/fhir/ValueSet/product-characteristic-codes

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningPackagedProductDefinition.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PackagedProductDefinition

Summary

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from PackagedProductDefinition

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... packageConversionFactor 0..*(Complex)Extension
URL: https://ancode.app/fhir/StructureDefinition/PackageConversionFactor
... status ?!Σ0..1CodeableConceptThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPackagedProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPackagedProductDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPackagedProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPackagedProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePackagedProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... packageConversionFactor 0..*(Complex)Extension
URL: https://ancode.app/fhir/StructureDefinition/PackageConversionFactor
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA unique identifier for this package as whole
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
... type Σ0..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping container etc
Binding: PackageType (example): A high level categorisation of a package.

... packageFor Σ0..*Reference(MedicinalProductDefinition)The product that this is a pack for
... status ?!Σ0..1CodeableConceptThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... containedItemQuantity Σ0..*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
... description Σ0..1markdownTextual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Binding: Jurisdiction ValueSet (example): Jurisdiction codes

... marketingStatus Σ0..*MarketingStatusAllows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
Binding: PackageCharacteristic (example): A characteristic of a package.


... copackagedIndicator Σ0..1booleanIf the drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ0..*Reference(Organization)Manufacturer of this package type (multiple means these are all possible manufacturers)
... package Σ0..1BackboneElementA packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
.... type Σ0..1CodeableConceptThe physical type of the container of the items
Binding: PackagingType (example): A high level categorisation of a package.

.... quantity Σ0..1integerThe quantity of this level of packaging in the package that contains it (with the outermost level being 1)
.... material Σ0..*CodeableConceptMaterial type of the package item
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... shelfLifeStorage Σ0..*BackboneElementShelf Life and storage information
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..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
..... period[x] Σ0..1The 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
...... periodDurationDuration
...... periodStringstring
..... specialPrecautionsForStorage Σ0..*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
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this package Item (multiple means these are all possible manufacturers)
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptA code expressing the type of characteristic
Binding: product-characteristic-codes (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... item Σ1..1CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct)The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
..... amount Σ0..1QuantityThe number of this type of item within this packaging
.... package Σ0..*See package (PackagedProductDefinition)Allows containers (and parts of containers) within containers, still a single packaged product

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PackagedProductDefinition.typeexamplePackageType
PackagedProductDefinition.statuspreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.codeexampleLegalStatusOfSupply
PackagedProductDefinition.legalStatusOfSupply.jurisdictionexampleJurisdiction ValueSet
PackagedProductDefinition.characteristicexamplePackageCharacteristic
PackagedProductDefinition.package.typeexamplePackagingType
PackagedProductDefinition.package.materialexamplePackageMaterial
PackagedProductDefinition.package.alternateMaterialexamplePackageMaterial
PackagedProductDefinition.package.property.typeexamplehttp://hl7.org/fhir/ValueSet/product-characteristic-codes

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningPackagedProductDefinition.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PackagedProductDefinition

Summary

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron