FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

12.30 Resource InventoryItem - Content

Orders and Observations icon Work GroupMaturity Level: 0 DraftSecurity 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. This resource is meant to contain the characteristics that are relevant for the logistics. If a clinical resource wishes to add such characteristics for logistics, the InventoryItem can be a placeholder for these. For example, adding Storage and Handling to a NutritionProduct. The InventoryItem can also reference the relevant specialized product resource, if one such resource exists. In the example above, the InventoryItem resource adds add inventory capabilities to the system that already uses NutritionProduct. The InventoryItem can also be used on its own for inventory specific purposes - one example is if the system tracks packages, specialized utensils and there is no clinical need, only inventory tracking, the InventoryItem may be used.

12.30.2 Boundaries and Relationships

The InventoryItem resource can be referenced from the following resources:

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

12.30.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

... 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

doco Documentation for this format icon

See the Extensions for this resource

 

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)

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 icon.

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)