Supply of Products for Healthcare
0.2.0 - CI Build

Supply of Products for Healthcare, published by IHE Pharmacy. This is not an authorized publication; it is the continuous build for version 0.2.0). 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: Logical Model - Item

Defining URL:https://www.ihe.net/fhir/StructureDefinition/model-item
Version:0.2.0
Name:Item
Status:Draft as of 2021-01-11T17:20:35+00:00
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 ")

Publisher:IHE Pharmacy
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.ihe.net/fhir/StructureDefinition/model-item

Formal Views of Profile Content

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

​This structure is derived from Element

Summary

Mandatory: 0 element (16 nested mandatory elements)

Structures

This structure refers to these other structures:

​This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. Item 0..*​ElementA 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
... identifier 0..*​IdentifierBusiness identifier(s) of the item, for example the GTIN code
... quantity 0..*SimpleQuantityThe Quantity of Base Unit of Measure (how many Base UoM are in this item).
... containedItem 1..1CodeableReference(Item)The contained item
... itemName 1..*​BackboneElementThe item name(s) - the brand name, or common name, functional name, generic name....
.... nameType 1..1​codeThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
.... language 1..1​codeThe language of the item
.... name 1..1​stringThe name of the item
... marketingAuthorization 0..*​BackboneElementMarketing authorization
.... holder 0..1CodeableReference()Responsible for the marketing authorization
.... number 0..1​IdentifierNumber or identifier of the marketing authorization
.... validityPeriod 0..1​PeriodValidity of the marketing authorization
.... issuer 0..1CodeableReference()Issuer of the marketing authorization
.... type 0..1​CodeableConcept Type of marketing authorization, e.g. 'emergency use authorization' or 'regular'
.... status 0..1​codeStatus of the marketing authorization
... description 0..1​BackboneElementThe description of the item
.... language 0..1​codeThe language of the item description
.... description 0..1​stringTextual description of the item
... dimensions 1..*​BackboneElementThe dimensions
.... dimensionType 1..1​CodeableConceptThe type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight'
.... value 1..1SimpleQuantityThe name of the item
... netContent 0..1SimpleQuantityNet content of the item
... attributes 1..*​BackboneElementThe attributes
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. ...
.... value[x] 0..1The name of the item
..... valueIntegerinteger
..... valueStringstring
..... valueBooleanboolean
... association 0..*​BackboneElement
.... associationType 1..1​CodeableConceptThe type of association
.... associatedProduct 1..1CodeableReference(Product | Item)The associated product - by code or reference
Binding: Product association type Value Set (preferred)
.... quantity 1..1​RatioThe quantity of the associated item in this item
... classification 0..*codeableConceptThe classification(s) of the product, e.g. ATC code, schedule, device class, ...
... dosageForm 0..1​CodeableConceptThe code for the dose form of the pharmaceutical item
... dosageRecommendation 0..1​stringThe stated recommended dosage of the item
... routeofAdministration 0..1​CodeableConceptThe stated recommended route of administration
... ingredients 0..1​BackboneElementThe item ingredients
.... ingredient 0..1CodeableReference()The ingredient
.... role 1..1​CodeableConceptThe role of the ingredient
.... strength 1..1​QuantityThe strength of the ingredient
... storageandHandling 0..*​BackboneElementThe Storage and Handling conditions for the item
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight'
.... value 0..1​RangeThe value of the storage / handling parameter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Item 0..*​ElementA 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
... extension 0..*​ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... identifier 0..*​IdentifierBusiness identifier(s) of the item, for example the GTIN code
... quantity 0..*SimpleQuantityThe Quantity of Base Unit of Measure (how many Base UoM are in this item).
... tradeItemUnitDescriptorCode 0..1​code'box', 'unit', 'pallet'
... itemName 1..*​BackboneElementThe item name(s) - the brand name, or common name, functional name, generic name....
.... nameType 1..1​codeThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
.... language 1..1​codeThe language of the item
.... name 1..1​stringThe name of the item
... marketingAuthorization 0..*​BackboneElementMarketing authorization
.... holder 0..1CodeableReference()Responsible for the marketing authorization
.... number 0..1​IdentifierNumber or identifier of the marketing authorization
.... validityPeriod 0..1​PeriodValidity of the marketing authorization
.... issuer 0..1CodeableReference()Issuer of the marketing authorization
.... type 0..1​CodeableConcept Type of marketing authorization, e.g. 'emergency use authorization' or 'regular'
.... status 0..1​codeStatus of the marketing authorization
... description 0..1​BackboneElementThe description of the item
.... language 0..1​codeThe language of the item description
.... description 0..1​stringTextual description of the item
... dimensions 1..*​BackboneElementThe dimensions
.... dimensionType 1..1​CodeableConceptThe type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight'
.... value 1..1SimpleQuantityThe name of the item
... netContent 0..1SimpleQuantityNet content of the item
... attributes 1..*​BackboneElementThe attributes
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. ...
.... value[x] 0..1The name of the item
..... valueIntegerinteger
..... valueStringstring
..... valueBooleanboolean
... association 0..*​BackboneElement
.... associationType 1..1​CodeableConceptThe type of association
.... associatedProduct 1..1CodeableReference(Product | Item)The associated product - by code or reference
Binding: Product association type Value Set (preferred)
.... quantity 1..1​RatioThe quantity of the associated item in this item
... classification 0..*codeableConceptThe classification(s) of the product, e.g. ATC code, schedule, device class, ...
... dosageForm 0..1​CodeableConceptThe code for the dose form of the pharmaceutical item
... dosageRecommendation 0..1​stringThe stated recommended dosage of the item
... routeofAdministration 0..1​CodeableConceptThe stated recommended route of administration
... ingredients 0..1​BackboneElementThe item ingredients
.... ingredient 0..1CodeableReference()The ingredient
.... role 1..1​CodeableConceptThe role of the ingredient
.... strength 1..1​QuantityThe strength of the ingredient
... storageandHandling 0..*​BackboneElementThe Storage and Handling conditions for the item
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight'
.... value 0..1​RangeThe value of the storage / handling parameter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Item 0..*​ElementA 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

doco Documentation for this format

​This structure is derived from Element

Summary

Mandatory: 0 element (16 nested mandatory elements)

Structures

This structure refers to these other structures:

Differential View

​This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. Item 0..*​ElementA 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
... identifier 0..*​IdentifierBusiness identifier(s) of the item, for example the GTIN code
... quantity 0..*SimpleQuantityThe Quantity of Base Unit of Measure (how many Base UoM are in this item).
... containedItem 1..1CodeableReference(Item)The contained item
... itemName 1..*​BackboneElementThe item name(s) - the brand name, or common name, functional name, generic name....
.... nameType 1..1​codeThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
.... language 1..1​codeThe language of the item
.... name 1..1​stringThe name of the item
... marketingAuthorization 0..*​BackboneElementMarketing authorization
.... holder 0..1CodeableReference()Responsible for the marketing authorization
.... number 0..1​IdentifierNumber or identifier of the marketing authorization
.... validityPeriod 0..1​PeriodValidity of the marketing authorization
.... issuer 0..1CodeableReference()Issuer of the marketing authorization
.... type 0..1​CodeableConcept Type of marketing authorization, e.g. 'emergency use authorization' or 'regular'
.... status 0..1​codeStatus of the marketing authorization
... description 0..1​BackboneElementThe description of the item
.... language 0..1​codeThe language of the item description
.... description 0..1​stringTextual description of the item
... dimensions 1..*​BackboneElementThe dimensions
.... dimensionType 1..1​CodeableConceptThe type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight'
.... value 1..1SimpleQuantityThe name of the item
... netContent 0..1SimpleQuantityNet content of the item
... attributes 1..*​BackboneElementThe attributes
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. ...
.... value[x] 0..1The name of the item
..... valueIntegerinteger
..... valueStringstring
..... valueBooleanboolean
... association 0..*​BackboneElement
.... associationType 1..1​CodeableConceptThe type of association
.... associatedProduct 1..1CodeableReference(Product | Item)The associated product - by code or reference
Binding: Product association type Value Set (preferred)
.... quantity 1..1​RatioThe quantity of the associated item in this item
... classification 0..*codeableConceptThe classification(s) of the product, e.g. ATC code, schedule, device class, ...
... dosageForm 0..1​CodeableConceptThe code for the dose form of the pharmaceutical item
... dosageRecommendation 0..1​stringThe stated recommended dosage of the item
... routeofAdministration 0..1​CodeableConceptThe stated recommended route of administration
... ingredients 0..1​BackboneElementThe item ingredients
.... ingredient 0..1CodeableReference()The ingredient
.... role 1..1​CodeableConceptThe role of the ingredient
.... strength 1..1​QuantityThe strength of the ingredient
... storageandHandling 0..*​BackboneElementThe Storage and Handling conditions for the item
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight'
.... value 0..1​RangeThe value of the storage / handling parameter

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Item 0..*​ElementA 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
... extension 0..*​ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... identifier 0..*​IdentifierBusiness identifier(s) of the item, for example the GTIN code
... quantity 0..*SimpleQuantityThe Quantity of Base Unit of Measure (how many Base UoM are in this item).
... tradeItemUnitDescriptorCode 0..1​code'box', 'unit', 'pallet'
... itemName 1..*​BackboneElementThe item name(s) - the brand name, or common name, functional name, generic name....
.... nameType 1..1​codeThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
.... language 1..1​codeThe language of the item
.... name 1..1​stringThe name of the item
... marketingAuthorization 0..*​BackboneElementMarketing authorization
.... holder 0..1CodeableReference()Responsible for the marketing authorization
.... number 0..1​IdentifierNumber or identifier of the marketing authorization
.... validityPeriod 0..1​PeriodValidity of the marketing authorization
.... issuer 0..1CodeableReference()Issuer of the marketing authorization
.... type 0..1​CodeableConcept Type of marketing authorization, e.g. 'emergency use authorization' or 'regular'
.... status 0..1​codeStatus of the marketing authorization
... description 0..1​BackboneElementThe description of the item
.... language 0..1​codeThe language of the item description
.... description 0..1​stringTextual description of the item
... dimensions 1..*​BackboneElementThe dimensions
.... dimensionType 1..1​CodeableConceptThe type of dimension, e.g. 'length', 'height', 'volume', 'spherical volume', 'weight'
.... value 1..1SimpleQuantityThe name of the item
... netContent 0..1SimpleQuantityNet content of the item
... attributes 1..*​BackboneElementThe attributes
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. ...
.... value[x] 0..1The name of the item
..... valueIntegerinteger
..... valueStringstring
..... valueBooleanboolean
... association 0..*​BackboneElement
.... associationType 1..1​CodeableConceptThe type of association
.... associatedProduct 1..1CodeableReference(Product | Item)The associated product - by code or reference
Binding: Product association type Value Set (preferred)
.... quantity 1..1​RatioThe quantity of the associated item in this item
... classification 0..*codeableConceptThe classification(s) of the product, e.g. ATC code, schedule, device class, ...
... dosageForm 0..1​CodeableConceptThe code for the dose form of the pharmaceutical item
... dosageRecommendation 0..1​stringThe stated recommended dosage of the item
... routeofAdministration 0..1​CodeableConceptThe stated recommended route of administration
... ingredients 0..1​BackboneElementThe item ingredients
.... ingredient 0..1CodeableReference()The ingredient
.... role 1..1​CodeableConceptThe role of the ingredient
.... strength 1..1​QuantityThe strength of the ingredient
... storageandHandling 0..*​BackboneElementThe Storage and Handling conditions for the item
.... attributeType 1..1​CodeableConceptThe type of attribute, e.g. 'transport humidity', 'transport temperature', 'sunlight'
.... value 0..1​RangeThe value of the storage / handling parameter

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
Item.association.associatedProductpreferredProductAssociationType

Constraints

IdPathDetailsRequirements
ele-1ItemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Item.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()