PackagedProductDefinition constructor

const PackagedProductDefinition({
  1. @Default(R4ResourceType.PackagedProductDefinition) R4ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') String? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. List<Identifier>? identifier,
  14. String? name,
  15. @JsonKey(name: '_name') Element? nameElement,
  16. CodeableConcept? type,
  17. List<Reference>? packageFor,
  18. CodeableConcept? status,
  19. FhirDateTime? statusDate,
  20. @JsonKey(name: '_statusDate') Element? statusDateElement,
  21. List<Quantity>? containedItemQuantity,
  22. FhirMarkdown? description,
  23. @JsonKey(name: '_description') Element? descriptionElement,
  24. List<PackagedProductDefinitionLegalStatusOfSupply>? legalStatusOfSupply,
  25. List<MarketingStatus>? marketingStatus,
  26. List<CodeableConcept>? characteristic,
  27. FhirBoolean? copackagedIndicator,
  28. @JsonKey(name: '_copackagedIndicator') Element? copackagedIndicatorElement,
  29. List<Reference>? manufacturer,
  30. PackagedProductDefinitionPackage? package,
})

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

resourceType This is a PackagedProductDefinition resource;

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;

meta The 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.;

implicitRules A 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.;

implicitRulesElement (_implicitRules): Extensions for implicitRules;

language The base language in which the resource is written.;

languageElement (_language): Extensions for language;

text A 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.;

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.;

extension_ May 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.;

modifierExtension May 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).;

identifier 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.;

name A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.;

nameElement (_name): Extensions for name;

type A high level category e.g. medicinal product, raw material, shipping/transport container, etc.;

packageFor The product this package model relates to, not the contents of the package (for which see package.containedItem).;

status 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.;

statusDate The date at which the given status became applicable.;

statusDateElement (_statusDate): Extensions for statusDate;

containedItemQuantity 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.;

description Textual description. Note that this is not the name of the package or product.;

descriptionElement (_description): Extensions for description;

legalStatusOfSupply The legal status of supply of the packaged item as classified by the regulator.;

marketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.;

characteristic Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".;

copackagedIndicator Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.;

copackagedIndicatorElement (_copackagedIndicator): Extensions for copackagedIndicator;

manufacturer Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.;

package 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).;

Implementation

///
/// [resourceType] This is a PackagedProductDefinition resource;
///
/// [id] The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;
///
/// [meta] The 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.;
///
/// [implicitRules] A 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.;
///
/// [implicitRulesElement] (_implicitRules): Extensions for implicitRules;
///
/// [language] The base language in which the resource is written.;
///
/// [languageElement] (_language): Extensions for language;
///
/// [text] A 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.;
///
/// [contained] These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.;
///
/// [extension_] May 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.;
///
/// [modifierExtension] May 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).;
///
/// [identifier] 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.;
///
/// [name] A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.;
///
/// [nameElement] (_name): Extensions for name;
///
/// [type] A high level category e.g. medicinal product, raw material, shipping/transport container, etc.;
///
/// [packageFor] The product this package model relates to, not the contents of the package (for which see package.containedItem).;
///
/// [status] 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.;
///
/// [statusDate] The date at which the given status became applicable.;
///
/// [statusDateElement] (_statusDate): Extensions for statusDate;
///
/// [containedItemQuantity] 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.;
///
/// [description] Textual description. Note that this is not the name of the package or product.;
///
/// [descriptionElement] (_description): Extensions for description;
///
/// [legalStatusOfSupply] The legal status of supply of the packaged item as classified by the regulator.;
///
/// [marketingStatus] Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.;
///
/// [characteristic] Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".;
///
/// [copackagedIndicator] Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.;
///
/// [copackagedIndicatorElement] (_copackagedIndicator): Extensions for copackagedIndicator;
///
/// [manufacturer] Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.;
///
/// [package] 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).;
const factory PackagedProductDefinition({
  @Default(R4ResourceType.PackagedProductDefinition)

  /// [resourceType] This is a PackagedProductDefinition resource;
  R4ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;
  @JsonKey(name: 'id') String? fhirId,

  /// [meta] The 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.;
  FhirMeta? meta,

  /// [implicitRules] A 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.;
  FhirUri? implicitRules,

  /// [implicitRulesElement] (_implicitRules): Extensions for implicitRules;
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.;
  FhirCode? language,

  /// [languageElement] (_language): Extensions for language;
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] A 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.;
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.;
  List<Resource>? contained,

  /// [extension_] May 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.;
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] May 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).;
  List<FhirExtension>? modifierExtension,

  /// [identifier] 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.;
  List<Identifier>? identifier,

  /// [name] A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.;
  String? name,

  /// [nameElement] (_name): Extensions for name;
  @JsonKey(name: '_name') Element? nameElement,

  /// [type] A high level category e.g. medicinal product, raw material, shipping/transport container, etc.;
  CodeableConcept? type,

  /// [packageFor] The product this package model relates to, not the contents of the package (for which see package.containedItem).;
  List<Reference>? packageFor,

  /// [status] 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.;
  CodeableConcept? status,

  /// [statusDate] The date at which the given status became applicable.;
  FhirDateTime? statusDate,

  /// [statusDateElement] (_statusDate): Extensions for statusDate;
  @JsonKey(name: '_statusDate') Element? statusDateElement,

  /// [containedItemQuantity] 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.;
  List<Quantity>? containedItemQuantity,

  /// [description] Textual description. Note that this is not the name of the package or product.;
  FhirMarkdown? description,

  /// [descriptionElement] (_description): Extensions for description;
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [legalStatusOfSupply] The legal status of supply of the packaged item as classified by the regulator.;
  List<PackagedProductDefinitionLegalStatusOfSupply>? legalStatusOfSupply,

  /// [marketingStatus] Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.;
  List<MarketingStatus>? marketingStatus,

  /// [characteristic] Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".;
  List<CodeableConcept>? characteristic,

  /// [copackagedIndicator] Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.;
  FhirBoolean? copackagedIndicator,

  /// [copackagedIndicatorElement] (_copackagedIndicator): Extensions for copackagedIndicator;
  @JsonKey(name: '_copackagedIndicator') Element? copackagedIndicatorElement,

  /// [manufacturer] Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.;
  List<Reference>? manufacturer,

  /// [package] 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).;
  PackagedProductDefinitionPackage? package,
}) = _PackagedProductDefinition;