Supply of Products for Healthcare (SUPPLY)
0.3.0 - ci-build
Supply of Products for Healthcare (SUPPLY), published by IHE Pharmacy Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-supply/ and changes regularly. See the Directory of published versions
Official URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/ItemModel | Version: 0.3.0 | |||
Draft as of 2024-06-18 | Computable Name: ItemModel | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
This is the logical model for the Inventory Change notification - an information about a change of items being added or removed from a given inventory position. This is to be typically used in differential inventory updates (e.g. “Since last time, the following items have been consumed”) or to register items added or subtracted (e.g. “The following 2 items were just discarded and should be deducted from inventory “)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ItemModel | 0..* | Element | Elements defined in Ancestors:@id, extension A tradeable item, i.e. something that can be manufactured and distributed by a given entity (in opposition to a Product, which is a abstracted representation of the product’s functionality Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier(s) of the item, for example the GTIN code | |
quantity | 0..* | SimpleQuantity | The Quantity of Base Unit of Measure (how many Base UoM are in this item). | |
containedItem | 1..1 | Reference(ItemModel) | The contained item | |
tradeItemUnitDescriptorCode | 0..1 | code | 'box', 'unit', 'pallet' | |
itemName | 1..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name.... | |
nameType | 1..1 | code | The type of name e.g. 'brand-name', 'functional-name', 'common-name' | |
language | 1..1 | code | The language of the item | |
name | 1..1 | string | The name of the item | |
marketingAuthorization | 0..* | BackboneElement | Marketing authorization | |
holder[x] | 0..1 | Responsible for the marketing authorization | ||
holderCodeableConcept | CodeableConcept | |||
holderReference | Reference(Any) | |||
number | 0..1 | Identifier | Number or identifier of the marketing authorization | |
validityPeriod | 0..1 | Period | Validity of the marketing authorization | |
issuer[x] | 0..1 | Issuer of the marketing authorization | ||
issuerCodeableConcept | CodeableConcept | |||
issuerReference | Reference(Any) | |||
type | 0..1 | CodeableConcept | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' | |
status | 0..1 | code | Status of the marketing authorization | |
description | 0..1 | BackboneElement | The description of the item | |
language | 0..1 | code | The language of the item description | |
description | 0..1 | string | Textual description of the item | |
dimensions | 1..* | BackboneElement | The dimensions | |
dimensionType | 1..1 | CodeableConcept | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' | |
value | 1..1 | SimpleQuantity | The dimension value | |
netContent | 0..1 | SimpleQuantity | Net content of the item | |
attributes | 1..* | BackboneElement | The attributes | |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. ... | |
value[x] | 0..1 | The value of the attribute | ||
valueInteger | integer | |||
valueString | string | |||
valueBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | 1..1 | The associated product - by code or reference Slice: Unordered, Open by type:$this | ||
associatedProductCodeableConcept | CodeableConcept | |||
associatedProductReference | Reference(ProductModel | ItemModel) | |||
associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The associated product - by code or reference Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated item in this item | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
dosageForm | 0..1 | CodeableConcept | The code for the dose form of the pharmaceutical item | |
dosageRecommendation | 0..1 | string | The stated recommended dosage of the item | |
routeofAdministration | 0..1 | CodeableConcept | The stated recommended route of administration | |
ingredients | 0..1 | BackboneElement | The item ingredients | |
ingredient[x] | 0..1 | The ingredient | ||
ingredientCodeableConcept | CodeableConcept | |||
ingredientReference | Reference(Any) | |||
role | 1..1 | CodeableConcept | The role of the ingredient | |
strength | 1..1 | Quantity | The strength of the ingredient | |
storageandHandling | 0..* | BackboneElement | The Storage and Handling conditions for the item | |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' | |
value | 0..1 | Range | The value of the storage / handling parameter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ItemModel | 0..* | Element | Elements defined in Ancestors:@id, extension A tradeable item, i.e. something that can be manufactured and distributed by a given entity (in opposition to a Product, which is a abstracted representation of the product’s functionality Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier(s) of the item, for example the GTIN code | |
quantity | 0..* | SimpleQuantity | The Quantity of Base Unit of Measure (how many Base UoM are in this item). | |
containedItem | 1..1 | Reference(ItemModel) | The contained item | |
tradeItemUnitDescriptorCode | 0..1 | code | 'box', 'unit', 'pallet' | |
itemName | 1..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name.... | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
nameType | 1..1 | code | The type of name e.g. 'brand-name', 'functional-name', 'common-name' | |
language | 1..1 | code | The language of the item | |
name | 1..1 | string | The name of the item | |
marketingAuthorization | 0..* | BackboneElement | Marketing authorization | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
holder[x] | 0..1 | Responsible for the marketing authorization | ||
holderCodeableConcept | CodeableConcept | |||
holderReference | Reference(Any) | |||
number | 0..1 | Identifier | Number or identifier of the marketing authorization | |
validityPeriod | 0..1 | Period | Validity of the marketing authorization | |
issuer[x] | 0..1 | Issuer of the marketing authorization | ||
issuerCodeableConcept | CodeableConcept | |||
issuerReference | Reference(Any) | |||
type | 0..1 | CodeableConcept | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' | |
status | 0..1 | code | Status of the marketing authorization | |
description | 0..1 | BackboneElement | The description of the item | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | The language of the item description | |
description | 0..1 | string | Textual description of the item | |
dimensions | 1..* | BackboneElement | The dimensions | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dimensionType | 1..1 | CodeableConcept | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' | |
value | 1..1 | SimpleQuantity | The dimension value | |
netContent | 0..1 | SimpleQuantity | Net content of the item | |
attributes | 1..* | BackboneElement | The attributes | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. ... | |
value[x] | 0..1 | The value of the attribute | ||
valueInteger | integer | |||
valueString | string | |||
valueBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The associated product - by code or reference Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated item in this item | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
dosageForm | 0..1 | CodeableConcept | The code for the dose form of the pharmaceutical item | |
dosageRecommendation | 0..1 | string | The stated recommended dosage of the item | |
routeofAdministration | 0..1 | CodeableConcept | The stated recommended route of administration | |
ingredients | 0..1 | BackboneElement | The item ingredients | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ingredient[x] | 0..1 | The ingredient | ||
ingredientCodeableConcept | CodeableConcept | |||
ingredientReference | Reference(Any) | |||
role | 1..1 | CodeableConcept | The role of the ingredient | |
strength | 1..1 | Quantity | The strength of the ingredient | |
storageandHandling | 0..* | BackboneElement | The Storage and Handling conditions for the item | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' | |
value | 0..1 | Range | The value of the storage / handling parameter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ItemModel | 0..* | Element | Elements defined in Ancestors:@id, extension A tradeable item, i.e. something that can be manufactured and distributed by a given entity (in opposition to a Product, which is a abstracted representation of the product’s functionality Instances of this logical model can be the target of a Reference | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
identifier | 0..* | Identifier | Business identifier(s) of the item, for example the GTIN code | |
quantity | 0..* | SimpleQuantity | The Quantity of Base Unit of Measure (how many Base UoM are in this item). | |
containedItem | 1..1 | Reference(ItemModel) | The contained item | |
tradeItemUnitDescriptorCode | 0..1 | code | 'box', 'unit', 'pallet' | |
itemName | 1..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name.... | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
nameType | 1..1 | code | The type of name e.g. 'brand-name', 'functional-name', 'common-name' | |
language | 1..1 | code | The language of the item | |
name | 1..1 | string | The name of the item | |
marketingAuthorization | 0..* | BackboneElement | Marketing authorization | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
holder[x] | 0..1 | Responsible for the marketing authorization | ||
holderCodeableConcept | CodeableConcept | |||
holderReference | Reference(Any) | |||
number | 0..1 | Identifier | Number or identifier of the marketing authorization | |
validityPeriod | 0..1 | Period | Validity of the marketing authorization | |
issuer[x] | 0..1 | Issuer of the marketing authorization | ||
issuerCodeableConcept | CodeableConcept | |||
issuerReference | Reference(Any) | |||
type | 0..1 | CodeableConcept | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' | |
status | 0..1 | code | Status of the marketing authorization | |
description | 0..1 | BackboneElement | The description of the item | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | The language of the item description | |
description | 0..1 | string | Textual description of the item | |
dimensions | 1..* | BackboneElement | The dimensions | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dimensionType | 1..1 | CodeableConcept | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' | |
value | 1..1 | SimpleQuantity | The dimension value | |
netContent | 0..1 | SimpleQuantity | Net content of the item | |
attributes | 1..* | BackboneElement | The attributes | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. ... | |
value[x] | 0..1 | The value of the attribute | ||
valueInteger | integer | |||
valueString | string | |||
valueBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The associated product - by code or reference Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated item in this item | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
dosageForm | 0..1 | CodeableConcept | The code for the dose form of the pharmaceutical item | |
dosageRecommendation | 0..1 | string | The stated recommended dosage of the item | |
routeofAdministration | 0..1 | CodeableConcept | The stated recommended route of administration | |
ingredients | 0..1 | BackboneElement | The item ingredients | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ingredient[x] | 0..1 | The ingredient | ||
ingredientCodeableConcept | CodeableConcept | |||
ingredientReference | Reference(Any) | |||
role | 1..1 | CodeableConcept | The role of the ingredient | |
strength | 1..1 | Quantity | The strength of the ingredient | |
storageandHandling | 0..* | BackboneElement | The Storage and Handling conditions for the item | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' | |
value | 0..1 | Range | The value of the storage / handling parameter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
This structure is derived from Element
Summary
Mandatory: 0 element(16 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ItemModel | 0..* | Element | Elements defined in Ancestors:@id, extension A tradeable item, i.e. something that can be manufactured and distributed by a given entity (in opposition to a Product, which is a abstracted representation of the product’s functionality Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier(s) of the item, for example the GTIN code | |
quantity | 0..* | SimpleQuantity | The Quantity of Base Unit of Measure (how many Base UoM are in this item). | |
containedItem | 1..1 | Reference(ItemModel) | The contained item | |
tradeItemUnitDescriptorCode | 0..1 | code | 'box', 'unit', 'pallet' | |
itemName | 1..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name.... | |
nameType | 1..1 | code | The type of name e.g. 'brand-name', 'functional-name', 'common-name' | |
language | 1..1 | code | The language of the item | |
name | 1..1 | string | The name of the item | |
marketingAuthorization | 0..* | BackboneElement | Marketing authorization | |
holder[x] | 0..1 | Responsible for the marketing authorization | ||
holderCodeableConcept | CodeableConcept | |||
holderReference | Reference(Any) | |||
number | 0..1 | Identifier | Number or identifier of the marketing authorization | |
validityPeriod | 0..1 | Period | Validity of the marketing authorization | |
issuer[x] | 0..1 | Issuer of the marketing authorization | ||
issuerCodeableConcept | CodeableConcept | |||
issuerReference | Reference(Any) | |||
type | 0..1 | CodeableConcept | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' | |
status | 0..1 | code | Status of the marketing authorization | |
description | 0..1 | BackboneElement | The description of the item | |
language | 0..1 | code | The language of the item description | |
description | 0..1 | string | Textual description of the item | |
dimensions | 1..* | BackboneElement | The dimensions | |
dimensionType | 1..1 | CodeableConcept | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' | |
value | 1..1 | SimpleQuantity | The dimension value | |
netContent | 0..1 | SimpleQuantity | Net content of the item | |
attributes | 1..* | BackboneElement | The attributes | |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. ... | |
value[x] | 0..1 | The value of the attribute | ||
valueInteger | integer | |||
valueString | string | |||
valueBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | 1..1 | The associated product - by code or reference Slice: Unordered, Open by type:$this | ||
associatedProductCodeableConcept | CodeableConcept | |||
associatedProductReference | Reference(ProductModel | ItemModel) | |||
associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The associated product - by code or reference Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated item in this item | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
dosageForm | 0..1 | CodeableConcept | The code for the dose form of the pharmaceutical item | |
dosageRecommendation | 0..1 | string | The stated recommended dosage of the item | |
routeofAdministration | 0..1 | CodeableConcept | The stated recommended route of administration | |
ingredients | 0..1 | BackboneElement | The item ingredients | |
ingredient[x] | 0..1 | The ingredient | ||
ingredientCodeableConcept | CodeableConcept | |||
ingredientReference | Reference(Any) | |||
role | 1..1 | CodeableConcept | The role of the ingredient | |
strength | 1..1 | Quantity | The strength of the ingredient | |
storageandHandling | 0..* | BackboneElement | The Storage and Handling conditions for the item | |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' | |
value | 0..1 | Range | The value of the storage / handling parameter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ItemModel | 0..* | Element | Elements defined in Ancestors:@id, extension A tradeable item, i.e. something that can be manufactured and distributed by a given entity (in opposition to a Product, which is a abstracted representation of the product’s functionality Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier(s) of the item, for example the GTIN code | |
quantity | 0..* | SimpleQuantity | The Quantity of Base Unit of Measure (how many Base UoM are in this item). | |
containedItem | 1..1 | Reference(ItemModel) | The contained item | |
tradeItemUnitDescriptorCode | 0..1 | code | 'box', 'unit', 'pallet' | |
itemName | 1..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name.... | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
nameType | 1..1 | code | The type of name e.g. 'brand-name', 'functional-name', 'common-name' | |
language | 1..1 | code | The language of the item | |
name | 1..1 | string | The name of the item | |
marketingAuthorization | 0..* | BackboneElement | Marketing authorization | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
holder[x] | 0..1 | Responsible for the marketing authorization | ||
holderCodeableConcept | CodeableConcept | |||
holderReference | Reference(Any) | |||
number | 0..1 | Identifier | Number or identifier of the marketing authorization | |
validityPeriod | 0..1 | Period | Validity of the marketing authorization | |
issuer[x] | 0..1 | Issuer of the marketing authorization | ||
issuerCodeableConcept | CodeableConcept | |||
issuerReference | Reference(Any) | |||
type | 0..1 | CodeableConcept | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' | |
status | 0..1 | code | Status of the marketing authorization | |
description | 0..1 | BackboneElement | The description of the item | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | The language of the item description | |
description | 0..1 | string | Textual description of the item | |
dimensions | 1..* | BackboneElement | The dimensions | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dimensionType | 1..1 | CodeableConcept | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' | |
value | 1..1 | SimpleQuantity | The dimension value | |
netContent | 0..1 | SimpleQuantity | Net content of the item | |
attributes | 1..* | BackboneElement | The attributes | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. ... | |
value[x] | 0..1 | The value of the attribute | ||
valueInteger | integer | |||
valueString | string | |||
valueBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The associated product - by code or reference Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated item in this item | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
dosageForm | 0..1 | CodeableConcept | The code for the dose form of the pharmaceutical item | |
dosageRecommendation | 0..1 | string | The stated recommended dosage of the item | |
routeofAdministration | 0..1 | CodeableConcept | The stated recommended route of administration | |
ingredients | 0..1 | BackboneElement | The item ingredients | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ingredient[x] | 0..1 | The ingredient | ||
ingredientCodeableConcept | CodeableConcept | |||
ingredientReference | Reference(Any) | |||
role | 1..1 | CodeableConcept | The role of the ingredient | |
strength | 1..1 | Quantity | The strength of the ingredient | |
storageandHandling | 0..* | BackboneElement | The Storage and Handling conditions for the item | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' | |
value | 0..1 | Range | The value of the storage / handling parameter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ItemModel | 0..* | Element | Elements defined in Ancestors:@id, extension A tradeable item, i.e. something that can be manufactured and distributed by a given entity (in opposition to a Product, which is a abstracted representation of the product’s functionality Instances of this logical model can be the target of a Reference | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
identifier | 0..* | Identifier | Business identifier(s) of the item, for example the GTIN code | |
quantity | 0..* | SimpleQuantity | The Quantity of Base Unit of Measure (how many Base UoM are in this item). | |
containedItem | 1..1 | Reference(ItemModel) | The contained item | |
tradeItemUnitDescriptorCode | 0..1 | code | 'box', 'unit', 'pallet' | |
itemName | 1..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name.... | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
nameType | 1..1 | code | The type of name e.g. 'brand-name', 'functional-name', 'common-name' | |
language | 1..1 | code | The language of the item | |
name | 1..1 | string | The name of the item | |
marketingAuthorization | 0..* | BackboneElement | Marketing authorization | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
holder[x] | 0..1 | Responsible for the marketing authorization | ||
holderCodeableConcept | CodeableConcept | |||
holderReference | Reference(Any) | |||
number | 0..1 | Identifier | Number or identifier of the marketing authorization | |
validityPeriod | 0..1 | Period | Validity of the marketing authorization | |
issuer[x] | 0..1 | Issuer of the marketing authorization | ||
issuerCodeableConcept | CodeableConcept | |||
issuerReference | Reference(Any) | |||
type | 0..1 | CodeableConcept | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' | |
status | 0..1 | code | Status of the marketing authorization | |
description | 0..1 | BackboneElement | The description of the item | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | The language of the item description | |
description | 0..1 | string | Textual description of the item | |
dimensions | 1..* | BackboneElement | The dimensions | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dimensionType | 1..1 | CodeableConcept | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' | |
value | 1..1 | SimpleQuantity | The dimension value | |
netContent | 0..1 | SimpleQuantity | Net content of the item | |
attributes | 1..* | BackboneElement | The attributes | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. ... | |
value[x] | 0..1 | The value of the attribute | ||
valueInteger | integer | |||
valueString | string | |||
valueBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The associated product - by code or reference Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated item in this item | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
dosageForm | 0..1 | CodeableConcept | The code for the dose form of the pharmaceutical item | |
dosageRecommendation | 0..1 | string | The stated recommended dosage of the item | |
routeofAdministration | 0..1 | CodeableConcept | The stated recommended route of administration | |
ingredients | 0..1 | BackboneElement | The item ingredients | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ingredient[x] | 0..1 | The ingredient | ||
ingredientCodeableConcept | CodeableConcept | |||
ingredientReference | Reference(Any) | |||
role | 1..1 | CodeableConcept | The role of the ingredient | |
strength | 1..1 | Quantity | The strength of the ingredient | |
storageandHandling | 0..* | BackboneElement | The Storage and Handling conditions for the item | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' | |
value | 0..1 | Range | The value of the storage / handling parameter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
This structure is derived from Element
Summary
Mandatory: 0 element(16 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: