Supply of Products for Healthcare (SUPPLY)
0.3.0 - ci-build International flag

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

Logical Model: ItemModel - Detailed Descriptions

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 ")

ShortA 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 ModelInstances 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

ShortBusiness identifier(s) of the item, for example the GTIN code
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
4. ItemModel.quantity
Definition

The Quantity of Base Unit of Measure (how many Base UoM are in this item).

ShortThe Quantity of Base Unit of Measure (how many Base UoM are in this item).
Control0..*
TypeQuantity(SimpleQuantity)
6. ItemModel.containedItem
Definition

The contained item

ShortThe contained item
Control1..1
TypeReference(ItemModel)
8. ItemModel.tradeItemUnitDescriptorCode
Definition

'box', 'unit', 'pallet'

Short'box', 'unit', 'pallet'
Control0..1
Typecode
Primitive ValueThis 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....

ShortThe item name(s) - the brand name, or common name, functional name, generic name....
Control1..*
TypeBackboneElement
12. ItemModel.itemName.nameType
Definition

The type of name e.g. 'brand-name', 'functional-name', 'common-name'

ShortThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ItemModel.itemName.language
Definition

The language of the item

ShortThe language of the item
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. ItemModel.itemName.name
Definition

The name of the item

ShortThe name of the item
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. ItemModel.marketingAuthorization
Definition

Marketing authorization

ShortMarketing authorization
Control0..*
TypeBackboneElement
20. ItemModel.marketingAuthorization.holder[x]
Definition

Responsible for the marketing authorization

ShortResponsible for the marketing authorization
Control0..1
TypeChoice of: CodeableConcept, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
22. ItemModel.marketingAuthorization.number
Definition

Number or identifier of the marketing authorization

ShortNumber or identifier of the marketing authorization
Control0..1
TypeIdentifier
24. ItemModel.marketingAuthorization.validityPeriod
Definition

Validity of the marketing authorization

ShortValidity of the marketing authorization
Control0..1
TypePeriod
26. ItemModel.marketingAuthorization.issuer[x]
Definition

Issuer of the marketing authorization

ShortIssuer of the marketing authorization
Control0..1
TypeChoice of: CodeableConcept, Reference
[x] NoteSeeChoice 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'

ShortType of marketing authorization, e.g. 'emergency use authorization' or 'regular'
Control0..1
TypeCodeableConcept
30. ItemModel.marketingAuthorization.status
Definition

Status of the marketing authorization

ShortStatus of the marketing authorization
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. ItemModel.description
Definition

The description of the item

ShortThe description of the item
Control0..1
TypeBackboneElement
34. ItemModel.description.language
Definition

The language of the item description

ShortThe language of the item description
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. ItemModel.description.description
Definition

Textual description of the item

ShortTextual description of the item
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. ItemModel.dimensions
Definition

The dimensions

ShortThe dimensions
Control1..*
TypeBackboneElement
40. ItemModel.dimensions.dimensionType
Definition

The type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight'

ShortThe type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight'
Control1..1
TypeCodeableConcept
42. ItemModel.dimensions.value
Definition

The dimension value

ShortThe dimension value
Control1..1
TypeQuantity(SimpleQuantity)
44. ItemModel.netContent
Definition

Net content of the item

ShortNet content of the item
Control0..1
TypeQuantity(SimpleQuantity)
46. ItemModel.attributes
Definition

The attributes

ShortThe attributes
Control1..*
TypeBackboneElement
48. ItemModel.attributes.attributeType
Definition

The type of attribute, e.g. ...

ShortThe type of attribute, e.g. ...
Control1..1
TypeCodeableConcept
50. ItemModel.attributes.value[x]
Definition

The value of the attribute

ShortThe value of the attribute
Control0..1
TypeChoice of: integer, string, boolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis 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

ShortFor 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
Control0..*
TypeBackboneElement
54. ItemModel.association.associationType
Definition

e.g. 'applied with' or 'used with' or 'to be mixed with

ShortThe type of association
Control1..1
TypeCodeableConcept
56. ItemModel.association.associatedProduct[x]
Definition

The associated product - by code or reference

ShortThe associated product - by code or reference
Control1..1
TypeChoice of: CodeableConcept, Reference(ProductModel, ItemModel)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on ItemModel.association.associatedProduct[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 58. ItemModel.association.associatedProduct[x]:associatedProductCodeableConcept
    Slice NameassociatedProductCodeableConcept
    Control0..1
    BindingThe 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)
    TypeCodeableConcept
    [x] NoteSeeChoice 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.

    ShortThe quantity of the associated item in this item
    Control1..1
    TypeRatio
    62. ItemModel.classification
    Definition

    The classification(s) of the product, e.g. ATC code, schedule, device class, ...

    ShortThe classification(s) of the product, e.g. ATC code, schedule, device class, ...
    Control0..*
    TypeCodeableConcept
    64. ItemModel.dosageForm
    Definition

    The code for the dose form of the pharmaceutical item

    ShortThe code for the dose form of the pharmaceutical item
    Control0..1
    TypeCodeableConcept
    66. ItemModel.dosageRecommendation
    Definition

    The stated recommended dosage of the item

    ShortThe stated recommended dosage of the item
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    68. ItemModel.routeofAdministration
    Definition

    The stated recommended route of administration

    ShortThe stated recommended route of administration
    Control0..1
    TypeCodeableConcept
    70. ItemModel.ingredients
    Definition

    The item ingredients

    ShortThe item ingredients
    Control0..1
    TypeBackboneElement
    72. ItemModel.ingredients.ingredient[x]
    Definition

    The ingredient

    ShortThe ingredient
    Control0..1
    TypeChoice of: CodeableConcept, Reference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    74. ItemModel.ingredients.role
    Definition

    The role of the ingredient

    ShortThe role of the ingredient
    Control1..1
    TypeCodeableConcept
    76. ItemModel.ingredients.strength
    Definition

    The strength of the ingredient

    ShortThe strength of the ingredient
    Control1..1
    TypeQuantity
    78. ItemModel.storageandHandling
    Definition

    The Storage and Handling conditions for the item

    ShortThe Storage and Handling conditions for the item
    Control0..*
    TypeBackboneElement
    80. ItemModel.storageandHandling.attributeType
    Definition

    The type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight'

    ShortThe type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight'
    Control1..1
    TypeCodeableConcept
    82. ItemModel.storageandHandling.value
    Definition

    The value of the storage / handling parameter

    ShortThe value of the storage / handling parameter
    Control0..1
    TypeRange