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
Draft as of 2024-06-18 |
Definitions for the ItemModel logical model.
Guidance on how to interpret the contents of this table can be found here
0. ItemModel | |
Definition | 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 ") |
Short | 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 |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. ItemModel.identifier | |
Definition | Business identifier(s) of the item, for example the GTIN code |
Short | Business identifier(s) of the item, for example the GTIN code |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
4. ItemModel.quantity | |
Definition | The Quantity of Base Unit of Measure (how many Base UoM are in this item). |
Short | The Quantity of Base Unit of Measure (how many Base UoM are in this item). |
Control | 0..* |
Type | Quantity(SimpleQuantity) |
6. ItemModel.containedItem | |
Definition | The contained item |
Short | The contained item |
Control | 1..1 |
Type | Reference(ItemModel) |
8. ItemModel.tradeItemUnitDescriptorCode | |
Definition | 'box', 'unit', 'pallet' |
Short | 'box', 'unit', 'pallet' |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. ItemModel.itemName | |
Definition | The item name(s) - the brand name, or common name, functional name, generic name.... |
Short | The item name(s) - the brand name, or common name, functional name, generic name.... |
Control | 1..* |
Type | BackboneElement |
12. ItemModel.itemName.nameType | |
Definition | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
Short | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. ItemModel.itemName.language | |
Definition | The language of the item |
Short | The language of the item |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. ItemModel.itemName.name | |
Definition | The name of the item |
Short | The name of the item |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. ItemModel.marketingAuthorization | |
Definition | Marketing authorization |
Short | Marketing authorization |
Control | 0..* |
Type | BackboneElement |
20. ItemModel.marketingAuthorization.holder[x] | |
Definition | Responsible for the marketing authorization |
Short | Responsible for the marketing authorization |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
22. ItemModel.marketingAuthorization.number | |
Definition | Number or identifier of the marketing authorization |
Short | Number or identifier of the marketing authorization |
Control | 0..1 |
Type | Identifier |
24. ItemModel.marketingAuthorization.validityPeriod | |
Definition | Validity of the marketing authorization |
Short | Validity of the marketing authorization |
Control | 0..1 |
Type | Period |
26. ItemModel.marketingAuthorization.issuer[x] | |
Definition | Issuer of the marketing authorization |
Short | Issuer of the marketing authorization |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
28. ItemModel.marketingAuthorization.type | |
Definition | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' |
Short | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' |
Control | 0..1 |
Type | CodeableConcept |
30. ItemModel.marketingAuthorization.status | |
Definition | Status of the marketing authorization |
Short | Status of the marketing authorization |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. ItemModel.description | |
Definition | The description of the item |
Short | The description of the item |
Control | 0..1 |
Type | BackboneElement |
34. ItemModel.description.language | |
Definition | The language of the item description |
Short | The language of the item description |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. ItemModel.description.description | |
Definition | Textual description of the item |
Short | Textual description of the item |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. ItemModel.dimensions | |
Definition | The dimensions |
Short | The dimensions |
Control | 1..* |
Type | BackboneElement |
40. ItemModel.dimensions.dimensionType | |
Definition | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' |
Short | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' |
Control | 1..1 |
Type | CodeableConcept |
42. ItemModel.dimensions.value | |
Definition | The dimension value |
Short | The dimension value |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
44. ItemModel.netContent | |
Definition | Net content of the item |
Short | Net content of the item |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
46. ItemModel.attributes | |
Definition | The attributes |
Short | The attributes |
Control | 1..* |
Type | BackboneElement |
48. ItemModel.attributes.attributeType | |
Definition | The type of attribute, e.g. ... |
Short | The type of attribute, e.g. ... |
Control | 1..1 |
Type | CodeableConcept |
50. ItemModel.attributes.value[x] | |
Definition | The value of the attribute |
Short | The value of the attribute |
Control | 0..1 |
Type | Choice of: integer, string, boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. ItemModel.association | |
Definition | 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 |
Short | 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 |
Control | 0..* |
Type | BackboneElement |
54. ItemModel.association.associationType | |
Definition | e.g. 'applied with' or 'used with' or 'to be mixed with |
Short | The type of association |
Control | 1..1 |
Type | CodeableConcept |
56. ItemModel.association.associatedProduct[x] | |
Definition | The associated product - by code or reference |
Short | The associated product - by code or reference |
Control | 1..1 |
Type | Choice of: CodeableConcept, Reference(ProductModel, ItemModel) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on ItemModel.association.associatedProduct[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
58. ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | |
Slice Name | associatedProductCodeableConcept |
Control | 0..1 |
Binding | The codes SHOULD be taken from Product association type Value Set (preferred to http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type ) |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
60. ItemModel.association.quantity | |
Definition | The quantity of the associated item in this item - Numerator is the quantity of the related item. Denominator is the quantity of the present item. For example a value of 20 means that this item contains 20 units of the related item; a value of 1:20 means the inverse - that the contained item contains 20 units of this item. |
Short | The quantity of the associated item in this item |
Control | 1..1 |
Type | Ratio |
62. ItemModel.classification | |
Definition | The classification(s) of the product, e.g. ATC code, schedule, device class, ... |
Short | The classification(s) of the product, e.g. ATC code, schedule, device class, ... |
Control | 0..* |
Type | CodeableConcept |
64. ItemModel.dosageForm | |
Definition | The code for the dose form of the pharmaceutical item |
Short | The code for the dose form of the pharmaceutical item |
Control | 0..1 |
Type | CodeableConcept |
66. ItemModel.dosageRecommendation | |
Definition | The stated recommended dosage of the item |
Short | The stated recommended dosage of the item |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. ItemModel.routeofAdministration | |
Definition | The stated recommended route of administration |
Short | The stated recommended route of administration |
Control | 0..1 |
Type | CodeableConcept |
70. ItemModel.ingredients | |
Definition | The item ingredients |
Short | The item ingredients |
Control | 0..1 |
Type | BackboneElement |
72. ItemModel.ingredients.ingredient[x] | |
Definition | The ingredient |
Short | The ingredient |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
74. ItemModel.ingredients.role | |
Definition | The role of the ingredient |
Short | The role of the ingredient |
Control | 1..1 |
Type | CodeableConcept |
76. ItemModel.ingredients.strength | |
Definition | The strength of the ingredient |
Short | The strength of the ingredient |
Control | 1..1 |
Type | Quantity |
78. ItemModel.storageandHandling | |
Definition | The Storage and Handling conditions for the item |
Short | The Storage and Handling conditions for the item |
Control | 0..* |
Type | BackboneElement |
80. ItemModel.storageandHandling.attributeType | |
Definition | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' |
Short | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' |
Control | 1..1 |
Type | CodeableConcept |
82. ItemModel.storageandHandling.value | |
Definition | The value of the storage / handling parameter |
Short | The value of the storage / handling parameter |
Control | 0..1 |
Type | Range |
Guidance on how to interpret the contents of this table can be found here
0. ItemModel | |
Definition | 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 ") Base definition for all elements in a resource. |
Short | 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 functionalityBase for all elements |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. ItemModel.identifier | |
Definition | Business identifier(s) of the item, for example the GTIN code |
Short | Business identifier(s) of the item, for example the GTIN code |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
4. ItemModel.quantity | |
Definition | The Quantity of Base Unit of Measure (how many Base UoM are in this item). |
Short | The Quantity of Base Unit of Measure (how many Base UoM are in this item). |
Control | 0..* |
Type | Quantity(SimpleQuantity) |
6. ItemModel.containedItem | |
Definition | The contained item |
Short | The contained item |
Control | 1..1 |
Type | Reference(ItemModel) |
8. ItemModel.tradeItemUnitDescriptorCode | |
Definition | 'box', 'unit', 'pallet' |
Short | 'box', 'unit', 'pallet' |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. ItemModel.itemName | |
Definition | The item name(s) - the brand name, or common name, functional name, generic name.... |
Short | The item name(s) - the brand name, or common name, functional name, generic name.... |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. ItemModel.itemName.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. ItemModel.itemName.nameType | |
Definition | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
Short | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. ItemModel.itemName.language | |
Definition | The language of the item |
Short | The language of the item |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. ItemModel.itemName.name | |
Definition | The name of the item |
Short | The name of the item |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. ItemModel.marketingAuthorization | |
Definition | Marketing authorization |
Short | Marketing authorization |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. ItemModel.marketingAuthorization.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
24. ItemModel.marketingAuthorization.holder[x] | |
Definition | Responsible for the marketing authorization |
Short | Responsible for the marketing authorization |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
26. ItemModel.marketingAuthorization.number | |
Definition | Number or identifier of the marketing authorization |
Short | Number or identifier of the marketing authorization |
Control | 0..1 |
Type | Identifier |
28. ItemModel.marketingAuthorization.validityPeriod | |
Definition | Validity of the marketing authorization |
Short | Validity of the marketing authorization |
Control | 0..1 |
Type | Period |
30. ItemModel.marketingAuthorization.issuer[x] | |
Definition | Issuer of the marketing authorization |
Short | Issuer of the marketing authorization |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
32. ItemModel.marketingAuthorization.type | |
Definition | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' |
Short | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' |
Control | 0..1 |
Type | CodeableConcept |
34. ItemModel.marketingAuthorization.status | |
Definition | Status of the marketing authorization |
Short | Status of the marketing authorization |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. ItemModel.description | |
Definition | The description of the item |
Short | The description of the item |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. ItemModel.description.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
40. ItemModel.description.language | |
Definition | The language of the item description |
Short | The language of the item description |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. ItemModel.description.description | |
Definition | Textual description of the item |
Short | Textual description of the item |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. ItemModel.dimensions | |
Definition | The dimensions |
Short | The dimensions |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. ItemModel.dimensions.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
48. ItemModel.dimensions.dimensionType | |
Definition | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' |
Short | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' |
Control | 1..1 |
Type | CodeableConcept |
50. ItemModel.dimensions.value | |
Definition | The dimension value |
Short | The dimension value |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
52. ItemModel.netContent | |
Definition | Net content of the item |
Short | Net content of the item |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
54. ItemModel.attributes | |
Definition | The attributes |
Short | The attributes |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. ItemModel.attributes.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
58. ItemModel.attributes.attributeType | |
Definition | The type of attribute, e.g. ... |
Short | The type of attribute, e.g. ... |
Control | 1..1 |
Type | CodeableConcept |
60. ItemModel.attributes.value[x] | |
Definition | The value of the attribute |
Short | The value of the attribute |
Control | 0..1 |
Type | Choice of: integer, string, boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. ItemModel.association | |
Definition | 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 |
Short | 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 |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. ItemModel.association.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
66. ItemModel.association.associationType | |
Definition | e.g. 'applied with' or 'used with' or 'to be mixed with |
Short | The type of association |
Control | 1..1 |
Type | CodeableConcept |
68. ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | |
Slice Name | associatedProductCodeableConcept |
Definition | The associated product - by code or reference |
Short | The associated product - by code or reference |
Control | 0..1 |
Binding | The codes SHOULD be taken from Product association type Value Set (preferred to http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type ) |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on ItemModel.association.associatedProduct[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
70. ItemModel.association.quantity | |
Definition | The quantity of the associated item in this item - Numerator is the quantity of the related item. Denominator is the quantity of the present item. For example a value of 20 means that this item contains 20 units of the related item; a value of 1:20 means the inverse - that the contained item contains 20 units of this item. |
Short | The quantity of the associated item in this item |
Control | 1..1 |
Type | Ratio |
72. ItemModel.classification | |
Definition | The classification(s) of the product, e.g. ATC code, schedule, device class, ... |
Short | The classification(s) of the product, e.g. ATC code, schedule, device class, ... |
Control | 0..* |
Type | CodeableConcept |
74. ItemModel.dosageForm | |
Definition | The code for the dose form of the pharmaceutical item |
Short | The code for the dose form of the pharmaceutical item |
Control | 0..1 |
Type | CodeableConcept |
76. ItemModel.dosageRecommendation | |
Definition | The stated recommended dosage of the item |
Short | The stated recommended dosage of the item |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
78. ItemModel.routeofAdministration | |
Definition | The stated recommended route of administration |
Short | The stated recommended route of administration |
Control | 0..1 |
Type | CodeableConcept |
80. ItemModel.ingredients | |
Definition | The item ingredients |
Short | The item ingredients |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
82. ItemModel.ingredients.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
84. ItemModel.ingredients.ingredient[x] | |
Definition | The ingredient |
Short | The ingredient |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
86. ItemModel.ingredients.role | |
Definition | The role of the ingredient |
Short | The role of the ingredient |
Control | 1..1 |
Type | CodeableConcept |
88. ItemModel.ingredients.strength | |
Definition | The strength of the ingredient |
Short | The strength of the ingredient |
Control | 1..1 |
Type | Quantity |
90. ItemModel.storageandHandling | |
Definition | The Storage and Handling conditions for the item |
Short | The Storage and Handling conditions for the item |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
92. ItemModel.storageandHandling.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
94. ItemModel.storageandHandling.attributeType | |
Definition | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' |
Short | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' |
Control | 1..1 |
Type | CodeableConcept |
96. ItemModel.storageandHandling.value | |
Definition | The value of the storage / handling parameter |
Short | The value of the storage / handling parameter |
Control | 0..1 |
Type | Range |
Guidance on how to interpret the contents of this table can be found here
0. ItemModel | |
Definition | 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 ") |
Short | 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 |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. ItemModel.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. ItemModel.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. ItemModel.identifier | |
Definition | Business identifier(s) of the item, for example the GTIN code |
Short | Business identifier(s) of the item, for example the GTIN code |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
8. ItemModel.quantity | |
Definition | The Quantity of Base Unit of Measure (how many Base UoM are in this item). |
Short | The Quantity of Base Unit of Measure (how many Base UoM are in this item). |
Control | 0..* |
Type | Quantity(SimpleQuantity) |
10. ItemModel.containedItem | |
Definition | The contained item |
Short | The contained item |
Control | 1..1 |
Type | Reference(ItemModel) |
12. ItemModel.tradeItemUnitDescriptorCode | |
Definition | 'box', 'unit', 'pallet' |
Short | 'box', 'unit', 'pallet' |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. ItemModel.itemName | |
Definition | The item name(s) - the brand name, or common name, functional name, generic name.... |
Short | The item name(s) - the brand name, or common name, functional name, generic name.... |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
16. ItemModel.itemName.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
18. ItemModel.itemName.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.itemName.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. ItemModel.itemName.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
22. ItemModel.itemName.nameType | |
Definition | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
Short | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. ItemModel.itemName.language | |
Definition | The language of the item |
Short | The language of the item |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. ItemModel.itemName.name | |
Definition | The name of the item |
Short | The name of the item |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. ItemModel.marketingAuthorization | |
Definition | Marketing authorization |
Short | Marketing authorization |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. ItemModel.marketingAuthorization.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
32. ItemModel.marketingAuthorization.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.marketingAuthorization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. ItemModel.marketingAuthorization.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
36. ItemModel.marketingAuthorization.holder[x] | |
Definition | Responsible for the marketing authorization |
Short | Responsible for the marketing authorization |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
38. ItemModel.marketingAuthorization.number | |
Definition | Number or identifier of the marketing authorization |
Short | Number or identifier of the marketing authorization |
Control | 0..1 |
Type | Identifier |
40. ItemModel.marketingAuthorization.validityPeriod | |
Definition | Validity of the marketing authorization |
Short | Validity of the marketing authorization |
Control | 0..1 |
Type | Period |
42. ItemModel.marketingAuthorization.issuer[x] | |
Definition | Issuer of the marketing authorization |
Short | Issuer of the marketing authorization |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
44. ItemModel.marketingAuthorization.type | |
Definition | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' |
Short | Type of marketing authorization, e.g. 'emergency use authorization' or 'regular' |
Control | 0..1 |
Type | CodeableConcept |
46. ItemModel.marketingAuthorization.status | |
Definition | Status of the marketing authorization |
Short | Status of the marketing authorization |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. ItemModel.description | |
Definition | The description of the item |
Short | The description of the item |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. ItemModel.description.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
52. ItemModel.description.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.description.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. ItemModel.description.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
56. ItemModel.description.language | |
Definition | The language of the item description |
Short | The language of the item description |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. ItemModel.description.description | |
Definition | Textual description of the item |
Short | Textual description of the item |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. ItemModel.dimensions | |
Definition | The dimensions |
Short | The dimensions |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. ItemModel.dimensions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
64. ItemModel.dimensions.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.dimensions.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
66. ItemModel.dimensions.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
68. ItemModel.dimensions.dimensionType | |
Definition | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' |
Short | The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight' |
Control | 1..1 |
Type | CodeableConcept |
70. ItemModel.dimensions.value | |
Definition | The dimension value |
Short | The dimension value |
Control | 1..1 |
Type | Quantity(SimpleQuantity) |
72. ItemModel.netContent | |
Definition | Net content of the item |
Short | Net content of the item |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
74. ItemModel.attributes | |
Definition | The attributes |
Short | The attributes |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. ItemModel.attributes.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
78. ItemModel.attributes.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.attributes.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
80. ItemModel.attributes.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
82. ItemModel.attributes.attributeType | |
Definition | The type of attribute, e.g. ... |
Short | The type of attribute, e.g. ... |
Control | 1..1 |
Type | CodeableConcept |
84. ItemModel.attributes.value[x] | |
Definition | The value of the attribute |
Short | The value of the attribute |
Control | 0..1 |
Type | Choice of: integer, string, boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
86. ItemModel.association | |
Definition | 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 |
Short | 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 |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
88. ItemModel.association.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
90. ItemModel.association.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.association.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
92. ItemModel.association.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
94. ItemModel.association.associationType | |
Definition | e.g. 'applied with' or 'used with' or 'to be mixed with |
Short | The type of association |
Control | 1..1 |
Type | CodeableConcept |
96. ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept | |
Slice Name | associatedProductCodeableConcept |
Definition | The associated product - by code or reference |
Short | The associated product - by code or reference |
Control | 0..1 |
Binding | The codes SHOULD be taken from Product association type Value Set (preferred to http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type ) |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Slicing | This element introduces a set of slices on ItemModel.association.associatedProduct[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
98. ItemModel.association.quantity | |
Definition | The quantity of the associated item in this item - Numerator is the quantity of the related item. Denominator is the quantity of the present item. For example a value of 20 means that this item contains 20 units of the related item; a value of 1:20 means the inverse - that the contained item contains 20 units of this item. |
Short | The quantity of the associated item in this item |
Control | 1..1 |
Type | Ratio |
100. ItemModel.classification | |
Definition | The classification(s) of the product, e.g. ATC code, schedule, device class, ... |
Short | The classification(s) of the product, e.g. ATC code, schedule, device class, ... |
Control | 0..* |
Type | CodeableConcept |
102. ItemModel.dosageForm | |
Definition | The code for the dose form of the pharmaceutical item |
Short | The code for the dose form of the pharmaceutical item |
Control | 0..1 |
Type | CodeableConcept |
104. ItemModel.dosageRecommendation | |
Definition | The stated recommended dosage of the item |
Short | The stated recommended dosage of the item |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
106. ItemModel.routeofAdministration | |
Definition | The stated recommended route of administration |
Short | The stated recommended route of administration |
Control | 0..1 |
Type | CodeableConcept |
108. ItemModel.ingredients | |
Definition | The item ingredients |
Short | The item ingredients |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
110. ItemModel.ingredients.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
112. ItemModel.ingredients.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.ingredients.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
114. ItemModel.ingredients.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
116. ItemModel.ingredients.ingredient[x] | |
Definition | The ingredient |
Short | The ingredient |
Control | 0..1 |
Type | Choice of: CodeableConcept, Reference |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
118. ItemModel.ingredients.role | |
Definition | The role of the ingredient |
Short | The role of the ingredient |
Control | 1..1 |
Type | CodeableConcept |
120. ItemModel.ingredients.strength | |
Definition | The strength of the ingredient |
Short | The strength of the ingredient |
Control | 1..1 |
Type | Quantity |
122. ItemModel.storageandHandling | |
Definition | The Storage and Handling conditions for the item |
Short | The Storage and Handling conditions for the item |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. ItemModel.storageandHandling.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
126. ItemModel.storageandHandling.extension | |
Definition | May 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 managable, 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. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on ItemModel.storageandHandling.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
128. ItemModel.storageandHandling.modifierExtension | |
Definition | May 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
130. ItemModel.storageandHandling.attributeType | |
Definition | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' |
Short | The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight' |
Control | 1..1 |
Type | CodeableConcept |
132. ItemModel.storageandHandling.value | |
Definition | The value of the storage / handling parameter |
Short | The value of the storage / handling parameter |
Control | 0..1 |
Type | Range |
IG © 2020+ IHE Pharmacy Technical Committee. Package ihe.pharm.supply#0.3.0 based on FHIR 5.0.0. Generated 2024-06-18
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change