This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

12.30 Resource InventoryItem - Content

Orders and Observations icon

Work Group

Maturity Level: 0

Draft

Security Category: Business

Compartments: No defined compartments

A functional description of an inventory item used in inventory and supply-related workflows.

12.30.1 Scope and Usage

The InventoryItem is used to define and specitfy the characteristics of a material item (Product) and the relevant characteristics when handling logistics: Inventory and Supply. This resource corresponds to (and expands) the InventoryReport resource's .item backbone element, and provides a reusable data object to express and use product characteristics in the Inventory and Supply (and Transport) aspects.

This resource approximately corresponds to "product" or "material" in ERP systems (e.g. SAP's MARA table) and to TradeItem in GS1 logistics standard - a core set of attributes that can be referred to when ordering, delivering, tracking or counting items, especially in situations where their clinical categorization (Medication or Device or BDP or Nutrition) is undefined or irrelevant - which is common in supply chain systems, especially in cross-realm, cross-border supplies.

The InventoryItem Resource:

is meant to be used in the logistics workflows aspects, when the specific resources cannot be used (due to indefinition, ambiguity, or need to cross-over between resources).
is NOT intended be used in clinical workflows, where the specific product resources shall be used: Medication, Device, etc.

The InventoryItem resource does not intend to provide a substitute for the other resources, nor overlap those in the clinical workflows, as those resources have their specific core characteristics. If a clinical resource wishes to add characteristics that are common for logistics, the InventoryItem can be a placeholder for these (e.g. adding Storage and Handling to a NutritionProduct). This resource is meant to contain the characteristics that are relevant for the logistics.

12.30.2 Boundaries and Relationships

The InventoryItem resource can be referenced from the following resources:

InventoryReport - when counting items in an inventory
Transport - for tracking the transport of inventory items
SupplyRequest- for requesting the supply of inventory items
SupplyDelivery - for reporting the delivery of inventory items
ServiceRequest - for example for requesting transport of items

Because the InventoryItem resource does not contain all the clinical characteristics of the products like Medication, Device, etc. the InventoryItem can refer to any of those product items.

12.30.3 References to this Resource

Resource References: itself, InventoryReport, SupplyDelivery and SupplyRequest

Structure

Name	Flags	Card.	Type	Description & Constraints
InventoryItem	D		DomainResource	A functional description of an inventory item used in inventory and supply-related workflows Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Business identifier for the inventory item
status	Σ	1..1	code	active \| inactive \| entered-in-error \| unknown Binding: InventoryItem Status Codes (Required)
category	Σ	0..*	CodeableConcept	Category or class of the item
code	Σ	0..*	CodeableConcept	Code designating the specific type of item
name	Σ	0..*	BackboneElement	The item name(s) - the brand name, or common name, functional name, generic name or others
nameType	Σ	1..1	Coding	The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItem Name Typess (Preferred)
language	Σ	1..1	code	The language used to express the item name Binding: Common Languages (Required)
name	Σ	1..1	string	The name or designation of the item
responsibleOrganization		0..*	BackboneElement	Organization(s) responsible for the product
role		1..1	CodeableConcept	The role of the organization e.g. manufacturer, distributor, or other
organization		1..1	Reference(Organization)	An organization that is associated with the item
description		0..1	BackboneElement	Descriptive characteristics of the item
language		0..1	code	The language that is used in the item description Binding: Common Languages (Required)
description		0..1	string	Textual description of the item
inventoryStatus	Σ	0..*	CodeableConcept	The usage status like recalled, in use, discarded
baseUnit	Σ	0..1	CodeableConcept	The base unit of measure - the unit in which the product is used or counted
netContent	Σ	0..1	SimpleQuantity	Net content or amount present in the item
association		0..*	BackboneElement	Association with other items or products
associationType	Σ	1..1	CodeableConcept	The type of association between the device and the other item
relatedItem	Σ	1..1	Reference(InventoryItem \| Medication \| MedicationKnowledge \| Device \| DeviceDefinition \| NutritionProduct \| BiologicallyDerivedProduct)	The related item or product
quantity	Σ	1..1	Ratio	The quantity of the product in this product
characteristic		0..*	BackboneElement	Characteristic of the item
characteristicType		1..1	CodeableConcept	The characteristic that is being defined
value[x]		1..1		The value of the attribute
valueString			string
valueInteger			integer
valueDecimal			decimal
valueBoolean			boolean
valueUrl			url
valueDateTime			dateTime
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueAnnotation			Annotation
valueAddress			Address
valueDuration			Duration
valueCodeableConcept			CodeableConcept
instance		0..1	BackboneElement	Instances or occurrences of the product
identifier		0..*	Identifier	The identifier for the physical instance, typically a serial number
lotNumber		0..1	string	The lot or batch number of the item
expiry		0..1	dateTime	The expiry date or date and time for the product
subject		0..1	Reference(Patient \| Organization)	The subject that the item is associated with
location		0..1	Reference(Location)	The location that the item is associated with
productReference		0..1	Reference(Medication \| Device \| NutritionProduct \| BiologicallyDerivedProduct)	Link to a product resource used in clinical workflows
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<InventoryItem xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for the inventory item --></identifier>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown -->
 <category><!-- 0..* CodeableConcept Category or class of the item --></category>
 <code><!-- 0..* CodeableConcept Code designating the specific type of item --></code>
 <name>  <!-- 0..* The item name(s) - the brand name, or common name, functional name, generic name or others -->
  <nameType><!-- 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name' --></nameType>
  <language value="[code]"/><!-- 1..1 The language used to express the item name -->
  <name value="[string]"/><!-- 1..1 The name or designation of the item -->
 </name>
 <responsibleOrganization>  <!-- 0..* Organization(s) responsible for the product -->
  <role><!-- 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other --></role>
  <organization><!-- 1..1 Reference(Organization) An organization that is associated with the item --></organization>
 </responsibleOrganization>
 <description>  <!-- 0..1 Descriptive characteristics of the item -->
  <language value="[code]"/><!-- 0..1 The language that is used in the item description -->
  <description value="[string]"/><!-- 0..1 Textual description of the item -->
 </description>
 <inventoryStatus><!-- 0..* CodeableConcept The usage status like recalled, in use, discarded --></inventoryStatus>
 <baseUnit><!-- 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted --></baseUnit>
 <netContent><!-- 0..1 Quantity(SimpleQuantity) Net content or amount present in the item --></netContent>
 <association>  <!-- 0..* Association with other items or products -->
  <associationType><!-- 1..1 CodeableConcept The type of association between the device and the other item --></associationType>
  <relatedItem><!-- 1..1 Reference(BiologicallyDerivedProduct|Device|
    DeviceDefinition|InventoryItem|Medication|MedicationKnowledge|
    NutritionProduct) The related item or product --></relatedItem>
  <quantity><!-- 1..1 Ratio The quantity of the product in this product --></quantity>
 </association>
 <characteristic>  <!-- 0..* Characteristic of the item -->
  <characteristicType><!-- 1..1 CodeableConcept The characteristic that is being defined --></characteristicType>
  <value[x]><!-- 1..1 string|integer|decimal|boolean|url|dateTime|Quantity|Range|
    Ratio|Annotation|Address|Duration|CodeableConcept The value of the attribute --></value[x]>
 </characteristic>
 <instance>  <!-- 0..1 Instances or occurrences of the product -->
  <identifier><!-- 0..* Identifier The identifier for the physical instance, typically a serial number --></identifier>
  <lotNumber value="[string]"/><!-- 0..1 The lot or batch number of the item -->
  <expiry value="[dateTime]"/><!-- 0..1 The expiry date or date and time for the product -->
  <subject><!-- 0..1 Reference(Organization|Patient) The subject that the item is associated with --></subject>
  <location><!-- 0..1 Reference(Location) The location that the item is associated with --></location>
 </instance>
 <productReference><!-- 0..1 Reference(BiologicallyDerivedProduct|Device|
   Medication|NutritionProduct) Link to a product resource used in clinical workflows --></productReference>
</InventoryItem>

JSON Template

{
  "resourceType" : "InventoryItem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for the inventory item
  "status" : "<code>", // R!  active | inactive | entered-in-error | unknown
  "category" : [{ CodeableConcept }], // Category or class of the item
  "code" : [{ CodeableConcept }], // Code designating the specific type of item
  "name" : [{ // The item name(s) - the brand name, or common name, functional name, generic name or others
    "nameType" : { Coding }, // R!  The type of name e.g. 'brand-name', 'functional-name', 'common-name'
    "language" : "<code>", // R!  The language used to express the item name
    "name" : "<string>" // R!  The name or designation of the item
  }],
  "responsibleOrganization" : [{ // Organization(s) responsible for the product
    "role" : { CodeableConcept }, // R!  The role of the organization e.g. manufacturer, distributor, or other
    "organization" : { Reference(Organization) } // R!  An organization that is associated with the item
  }],
  "description" : { // Descriptive characteristics of the item
    "language" : "<code>", // The language that is used in the item description
    "description" : "<string>" // Textual description of the item
  },
  "inventoryStatus" : [{ CodeableConcept }], // The usage status like recalled, in use, discarded
  "baseUnit" : { CodeableConcept }, // The base unit of measure - the unit in which the product is used or counted
  "netContent" : { Quantity(SimpleQuantity) }, // Net content or amount present in the item
  "association" : [{ // Association with other items or products
    "associationType" : { CodeableConcept }, // R!  The type of association between the device and the other item
    "relatedItem" : { Reference(BiologicallyDerivedProduct|Device|
    DeviceDefinition|InventoryItem|Medication|MedicationKnowledge|
    NutritionProduct) }, // R!  The related item or product
    "quantity" : { Ratio } // R!  The quantity of the product in this product
  }],
  "characteristic" : [{ // Characteristic of the item
    "characteristicType" : { CodeableConcept }, // R!  The characteristic that is being defined
    // value[x]: The value of the attribute. One of these 13:
    "valueString" : "<string>",
    "valueInteger" : <integer>,
    "valueDecimal" : <decimal>,
    "valueBoolean" : <boolean>,
    "valueUrl" : "<url>",
    "valueDateTime" : "<dateTime>",
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueAnnotation" : { Annotation },
    "valueAddress" : { Address },
    "valueDuration" : { Duration },
    "valueCodeableConcept" : { CodeableConcept }
  }],
  "instance" : { // Instances or occurrences of the product
    "identifier" : [{ Identifier }], // The identifier for the physical instance, typically a serial number
    "lotNumber" : "<string>", // The lot or batch number of the item
    "expiry" : "<dateTime>", // The expiry date or date and time for the product
    "subject" : { Reference(Organization|Patient) }, // The subject that the item is associated with
    "location" : { Reference(Location) } // The location that the item is associated with
  },
  "productReference" : { Reference(BiologicallyDerivedProduct|Device|
   Medication|NutritionProduct) } // Link to a product resource used in clinical workflows
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:InventoryItem;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for the inventory item
  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Category or class of the item
  fhir:code  ( [ CodeableConcept ] ... ) ; # 0..* Code designating the specific type of item
  fhir:name ( [ # 0..* The item name(s) - the brand name, or common name, functional name, generic name or others
    fhir:nameType [ Coding ] ; # 1..1 The type of name e.g. 'brand-name', 'functional-name', 'common-name'
    fhir:language [ code ] ; # 1..1 The language used to express the item name
    fhir:name [ string ] ; # 1..1 The name or designation of the item
  ] ... ) ;
  fhir:responsibleOrganization ( [ # 0..* Organization(s) responsible for the product
    fhir:role [ CodeableConcept ] ; # 1..1 The role of the organization e.g. manufacturer, distributor, or other
    fhir:organization [ Reference(Organization) ] ; # 1..1 An organization that is associated with the item
  ] ... ) ;
  fhir:description [ # 0..1 Descriptive characteristics of the item
    fhir:language [ code ] ; # 0..1 The language that is used in the item description
    fhir:description [ string ] ; # 0..1 Textual description of the item
  ] ;
  fhir:inventoryStatus  ( [ CodeableConcept ] ... ) ; # 0..* The usage status like recalled, in use, discarded
  fhir:baseUnit [ CodeableConcept ] ; # 0..1 The base unit of measure - the unit in which the product is used or counted
  fhir:netContent [ Quantity(SimpleQuantity) ] ; # 0..1 Net content or amount present in the item
  fhir:association ( [ # 0..* Association with other items or products
    fhir:associationType [ CodeableConcept ] ; # 1..1 The type of association between the device and the other item
    fhir:relatedItem [ Reference(BiologicallyDerivedProduct|Device|DeviceDefinition|InventoryItem|Medication|
  MedicationKnowledge|NutritionProduct) ] ; # 1..1 The related item or product
    fhir:quantity [ Ratio ] ; # 1..1 The quantity of the product in this product
  ] ... ) ;
  fhir:characteristic ( [ # 0..* Characteristic of the item
    fhir:characteristicType [ CodeableConcept ] ; # 1..1 The characteristic that is being defined
    # value[x] : 1..1 The value of the attribute. One of these 13
      fhir:value [  a fhir:string ; string ]
      fhir:value [  a fhir:integer ; integer ]
      fhir:value [  a fhir:decimal ; decimal ]
      fhir:value [  a fhir:boolean ; boolean ]
      fhir:value [  a fhir:url ; url ]
      fhir:value [  a fhir:dateTime ; dateTime ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:Ratio ; Ratio ]
      fhir:value [  a fhir:Annotation ; Annotation ]
      fhir:value [  a fhir:Address ; Address ]
      fhir:value [  a fhir:Duration ; Duration ]
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  fhir:instance [ # 0..1 Instances or occurrences of the product
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* The identifier for the physical instance, typically a serial number
    fhir:lotNumber [ string ] ; # 0..1 The lot or batch number of the item
    fhir:expiry [ dateTime ] ; # 0..1 The expiry date or date and time for the product
    fhir:subject [ Reference(Organization|Patient) ] ; # 0..1 The subject that the item is associated with
    fhir:location [ Reference(Location) ] ; # 0..1 The location that the item is associated with
  ] ;
  fhir:productReference [ Reference(BiologicallyDerivedProduct|Device|Medication|NutritionProduct) ] ; # 0..1 Link to a product resource used in clinical workflows
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
InventoryItem	D		DomainResource	A functional description of an inventory item used in inventory and supply-related workflows Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Business identifier for the inventory item
status	Σ	1..1	code	active \| inactive \| entered-in-error \| unknown Binding: InventoryItem Status Codes (Required)
category	Σ	0..*	CodeableConcept	Category or class of the item
code	Σ	0..*	CodeableConcept	Code designating the specific type of item
name	Σ	0..*	BackboneElement	The item name(s) - the brand name, or common name, functional name, generic name or others
nameType	Σ	1..1	Coding	The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItem Name Typess (Preferred)
language	Σ	1..1	code	The language used to express the item name Binding: Common Languages (Required)
name	Σ	1..1	string	The name or designation of the item
responsibleOrganization		0..*	BackboneElement	Organization(s) responsible for the product
role		1..1	CodeableConcept	The role of the organization e.g. manufacturer, distributor, or other
organization		1..1	Reference(Organization)	An organization that is associated with the item
description		0..1	BackboneElement	Descriptive characteristics of the item
language		0..1	code	The language that is used in the item description Binding: Common Languages (Required)
description		0..1	string	Textual description of the item
inventoryStatus	Σ	0..*	CodeableConcept	The usage status like recalled, in use, discarded
baseUnit	Σ	0..1	CodeableConcept	The base unit of measure - the unit in which the product is used or counted
netContent	Σ	0..1	SimpleQuantity	Net content or amount present in the item
association		0..*	BackboneElement	Association with other items or products
associationType	Σ	1..1	CodeableConcept	The type of association between the device and the other item
relatedItem	Σ	1..1	Reference(InventoryItem \| Medication \| MedicationKnowledge \| Device \| DeviceDefinition \| NutritionProduct \| BiologicallyDerivedProduct)	The related item or product
quantity	Σ	1..1	Ratio	The quantity of the product in this product
characteristic		0..*	BackboneElement	Characteristic of the item
characteristicType		1..1	CodeableConcept	The characteristic that is being defined
value[x]		1..1		The value of the attribute
valueString			string
valueInteger			integer
valueDecimal			decimal
valueBoolean			boolean
valueUrl			url
valueDateTime			dateTime
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueAnnotation			Annotation
valueAddress			Address
valueDuration			Duration
valueCodeableConcept			CodeableConcept
instance		0..1	BackboneElement	Instances or occurrences of the product
identifier		0..*	Identifier	The identifier for the physical instance, typically a serial number
lotNumber		0..1	string	The lot or batch number of the item
expiry		0..1	dateTime	The expiry date or date and time for the product
subject		0..1	Reference(Patient \| Organization)	The subject that the item is associated with
location		0..1	Reference(Location)	The location that the item is associated with
productReference		0..1	Reference(Medication \| Device \| NutritionProduct \| BiologicallyDerivedProduct)	Link to a product resource used in clinical workflows
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<InventoryItem xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for the inventory item --></identifier>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | unknown -->
 <category><!-- 0..* CodeableConcept Category or class of the item --></category>
 <code><!-- 0..* CodeableConcept Code designating the specific type of item --></code>
 <name>  <!-- 0..* The item name(s) - the brand name, or common name, functional name, generic name or others -->
  <nameType><!-- 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name' --></nameType>
  <language value="[code]"/><!-- 1..1 The language used to express the item name -->
  <name value="[string]"/><!-- 1..1 The name or designation of the item -->
 </name>
 <responsibleOrganization>  <!-- 0..* Organization(s) responsible for the product -->
  <role><!-- 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other --></role>
  <organization><!-- 1..1 Reference(Organization) An organization that is associated with the item --></organization>
 </responsibleOrganization>
 <description>  <!-- 0..1 Descriptive characteristics of the item -->
  <language value="[code]"/><!-- 0..1 The language that is used in the item description -->
  <description value="[string]"/><!-- 0..1 Textual description of the item -->
 </description>
 <inventoryStatus><!-- 0..* CodeableConcept The usage status like recalled, in use, discarded --></inventoryStatus>
 <baseUnit><!-- 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted --></baseUnit>
 <netContent><!-- 0..1 Quantity(SimpleQuantity) Net content or amount present in the item --></netContent>
 <association>  <!-- 0..* Association with other items or products -->
  <associationType><!-- 1..1 CodeableConcept The type of association between the device and the other item --></associationType>
  <relatedItem><!-- 1..1 Reference(BiologicallyDerivedProduct|Device|
    DeviceDefinition|InventoryItem|Medication|MedicationKnowledge|
    NutritionProduct) The related item or product --></relatedItem>
  <quantity><!-- 1..1 Ratio The quantity of the product in this product --></quantity>
 </association>
 <characteristic>  <!-- 0..* Characteristic of the item -->
  <characteristicType><!-- 1..1 CodeableConcept The characteristic that is being defined --></characteristicType>
  <value[x]><!-- 1..1 string|integer|decimal|boolean|url|dateTime|Quantity|Range|
    Ratio|Annotation|Address|Duration|CodeableConcept The value of the attribute --></value[x]>
 </characteristic>
 <instance>  <!-- 0..1 Instances or occurrences of the product -->
  <identifier><!-- 0..* Identifier The identifier for the physical instance, typically a serial number --></identifier>
  <lotNumber value="[string]"/><!-- 0..1 The lot or batch number of the item -->
  <expiry value="[dateTime]"/><!-- 0..1 The expiry date or date and time for the product -->
  <subject><!-- 0..1 Reference(Organization|Patient) The subject that the item is associated with --></subject>
  <location><!-- 0..1 Reference(Location) The location that the item is associated with --></location>
 </instance>
 <productReference><!-- 0..1 Reference(BiologicallyDerivedProduct|Device|
   Medication|NutritionProduct) Link to a product resource used in clinical workflows --></productReference>
</InventoryItem>

JSON Template

{
  "resourceType" : "InventoryItem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for the inventory item
  "status" : "<code>", // R!  active | inactive | entered-in-error | unknown
  "category" : [{ CodeableConcept }], // Category or class of the item
  "code" : [{ CodeableConcept }], // Code designating the specific type of item
  "name" : [{ // The item name(s) - the brand name, or common name, functional name, generic name or others
    "nameType" : { Coding }, // R!  The type of name e.g. 'brand-name', 'functional-name', 'common-name'
    "language" : "<code>", // R!  The language used to express the item name
    "name" : "<string>" // R!  The name or designation of the item
  }],
  "responsibleOrganization" : [{ // Organization(s) responsible for the product
    "role" : { CodeableConcept }, // R!  The role of the organization e.g. manufacturer, distributor, or other
    "organization" : { Reference(Organization) } // R!  An organization that is associated with the item
  }],
  "description" : { // Descriptive characteristics of the item
    "language" : "<code>", // The language that is used in the item description
    "description" : "<string>" // Textual description of the item
  },
  "inventoryStatus" : [{ CodeableConcept }], // The usage status like recalled, in use, discarded
  "baseUnit" : { CodeableConcept }, // The base unit of measure - the unit in which the product is used or counted
  "netContent" : { Quantity(SimpleQuantity) }, // Net content or amount present in the item
  "association" : [{ // Association with other items or products
    "associationType" : { CodeableConcept }, // R!  The type of association between the device and the other item
    "relatedItem" : { Reference(BiologicallyDerivedProduct|Device|
    DeviceDefinition|InventoryItem|Medication|MedicationKnowledge|
    NutritionProduct) }, // R!  The related item or product
    "quantity" : { Ratio } // R!  The quantity of the product in this product
  }],
  "characteristic" : [{ // Characteristic of the item
    "characteristicType" : { CodeableConcept }, // R!  The characteristic that is being defined
    // value[x]: The value of the attribute. One of these 13:
    "valueString" : "<string>",
    "valueInteger" : <integer>,
    "valueDecimal" : <decimal>,
    "valueBoolean" : <boolean>,
    "valueUrl" : "<url>",
    "valueDateTime" : "<dateTime>",
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueRatio" : { Ratio },
    "valueAnnotation" : { Annotation },
    "valueAddress" : { Address },
    "valueDuration" : { Duration },
    "valueCodeableConcept" : { CodeableConcept }
  }],
  "instance" : { // Instances or occurrences of the product
    "identifier" : [{ Identifier }], // The identifier for the physical instance, typically a serial number
    "lotNumber" : "<string>", // The lot or batch number of the item
    "expiry" : "<dateTime>", // The expiry date or date and time for the product
    "subject" : { Reference(Organization|Patient) }, // The subject that the item is associated with
    "location" : { Reference(Location) } // The location that the item is associated with
  },
  "productReference" : { Reference(BiologicallyDerivedProduct|Device|
   Medication|NutritionProduct) } // Link to a product resource used in clinical workflows
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:InventoryItem;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for the inventory item
  fhir:status [ code ] ; # 1..1 active | inactive | entered-in-error | unknown
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Category or class of the item
  fhir:code  ( [ CodeableConcept ] ... ) ; # 0..* Code designating the specific type of item
  fhir:name ( [ # 0..* The item name(s) - the brand name, or common name, functional name, generic name or others
    fhir:nameType [ Coding ] ; # 1..1 The type of name e.g. 'brand-name', 'functional-name', 'common-name'
    fhir:language [ code ] ; # 1..1 The language used to express the item name
    fhir:name [ string ] ; # 1..1 The name or designation of the item
  ] ... ) ;
  fhir:responsibleOrganization ( [ # 0..* Organization(s) responsible for the product
    fhir:role [ CodeableConcept ] ; # 1..1 The role of the organization e.g. manufacturer, distributor, or other
    fhir:organization [ Reference(Organization) ] ; # 1..1 An organization that is associated with the item
  ] ... ) ;
  fhir:description [ # 0..1 Descriptive characteristics of the item
    fhir:language [ code ] ; # 0..1 The language that is used in the item description
    fhir:description [ string ] ; # 0..1 Textual description of the item
  ] ;
  fhir:inventoryStatus  ( [ CodeableConcept ] ... ) ; # 0..* The usage status like recalled, in use, discarded
  fhir:baseUnit [ CodeableConcept ] ; # 0..1 The base unit of measure - the unit in which the product is used or counted
  fhir:netContent [ Quantity(SimpleQuantity) ] ; # 0..1 Net content or amount present in the item
  fhir:association ( [ # 0..* Association with other items or products
    fhir:associationType [ CodeableConcept ] ; # 1..1 The type of association between the device and the other item
    fhir:relatedItem [ Reference(BiologicallyDerivedProduct|Device|DeviceDefinition|InventoryItem|Medication|
  MedicationKnowledge|NutritionProduct) ] ; # 1..1 The related item or product
    fhir:quantity [ Ratio ] ; # 1..1 The quantity of the product in this product
  ] ... ) ;
  fhir:characteristic ( [ # 0..* Characteristic of the item
    fhir:characteristicType [ CodeableConcept ] ; # 1..1 The characteristic that is being defined
    # value[x] : 1..1 The value of the attribute. One of these 13
      fhir:value [  a fhir:string ; string ]
      fhir:value [  a fhir:integer ; integer ]
      fhir:value [  a fhir:decimal ; decimal ]
      fhir:value [  a fhir:boolean ; boolean ]
      fhir:value [  a fhir:url ; url ]
      fhir:value [  a fhir:dateTime ; dateTime ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:Ratio ; Ratio ]
      fhir:value [  a fhir:Annotation ; Annotation ]
      fhir:value [  a fhir:Address ; Address ]
      fhir:value [  a fhir:Duration ; Duration ]
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  fhir:instance [ # 0..1 Instances or occurrences of the product
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* The identifier for the physical instance, typically a serial number
    fhir:lotNumber [ string ] ; # 0..1 The lot or batch number of the item
    fhir:expiry [ dateTime ] ; # 0..1 The expiry date or date and time for the product
    fhir:subject [ Reference(Organization|Patient) ] ; # 0..1 The subject that the item is associated with
    fhir:location [ Reference(Location) ] ; # 0..1 The location that the item is associated with
  ] ;
  fhir:productReference [ Reference(BiologicallyDerivedProduct|Device|Medication|NutritionProduct) ] ; # 0..1 Link to a product resource used in clinical workflows
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

12.30.4.1 Terminology Bindings

Path	ValueSet	Type	Documentation
InventoryItem.status	InventoryItemStatusCodes	Required	InventoryItem Status Codes
InventoryItem.name.nameType	InventoryItemStatusCodes (a valid code from InventoryItem Name Type)	Preferred	InventoryItem Name Types
InventoryItem.name.language	CommonLanguages	Required	This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
InventoryItem.description.language	CommonLanguages	Required	This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)

Path

ValueSet

Type

Documentation

InventoryItem.status

InventoryItemStatusCodes

Required

InventoryItem Status Codes

InventoryItem.name.nameType

InventoryItemStatusCodes (a valid code from InventoryItem Name Type)

Preferred

InventoryItem Name Types

InventoryItem.name.language

CommonLanguages

Required

This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)

InventoryItem.description.language

CommonLanguages

Required

This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)

Note to Implementers: TThe draft resource InventoryItem is intended to satisfy a narrow set of use cases. Implementer feedback is welcome, and needed, to assess the resource's suitability and viability. Without implementation feedback, this resource may be removed in future releases of FHIR.

Feedback is welcome here .

12.30.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
code TU	token	Search for products that match this code	InventoryItem.code
identifier TU	token	The identifier of the item	InventoryItem.identifier
status TU	token	The status of the item	InventoryItem.status
subject TU	reference	The identity of a patient for whom to list associations	InventoryItem.instance.subject (Organization, Patient)