Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

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.

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.

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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem DDomainResourceA 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..*IdentifierBusiness identifier for the inventory item

... status Σ1..1codeactive | inactive | entered-in-error | unknown
Binding: InventoryItem Status Codes (Required)
... category Σ0..*CodeableConceptCategory or class of the item

... name Σ0..*BackboneElementThe item name(s) - the brand name, or common name, functional name, generic name or others

.... nameType Σ1..1CodingThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
Binding: InventoryItem Name Typess (Preferred)
.... language Σ1..1codeThe language used to express the item name
Binding: Common Languages (Required)
.... name Σ1..1stringThe name or designation of the item
... responsibleOrganization 0..*BackboneElementOrganization(s) responsible for the product

.... role 1..1CodeableConceptThe role of the organization e.g. manufacturer, distributor, or other
.... organization 1..1Reference(Organization)An organization that is associated with the item
... description 0..1BackboneElementDescriptive characteristics of the item
.... language 0..1codeThe language that is used in the item description
Binding: Common Languages (Required)
.... description 0..1stringTextual description of the item
... inventoryStatus Σ0..*CodeableConceptThe usage status like recalled, in use, discarded

... baseUnit Σ0..1CodeableConceptThe base unit of measure - the unit in which the product is used or counted
... netContent Σ0..1SimpleQuantityNet content or amount present in the item
... association 0..*BackboneElementAssociation with other items or products

.... associationType Σ1..1CodeableConceptThe type of association between the device and the other item
.... relatedItem Σ1..1Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct)The related item or product
.... quantity Σ1..1RatioThe quantity of the product in this product
... characteristic 0..*BackboneElementCharacteristic of the item

.... characteristicType 1..1CodeableConceptThe characteristic that is being defined
.... value[x] 1..1The value of the attribute
..... valueStringstring
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBooleanboolean
..... valueUrlurl
..... valueDateTimedateTime
..... valueQuantityQuantity
..... valueRangeRange
..... valueRatioRatio
..... valueAnnotationAnnotation
..... valueAddressAddress
..... valueDurationDuration
..... valueCodeableConceptCodeableConcept
... instance 0..1BackboneElementInstances or occurrences of the product
.... identifier 0..*IdentifierThe identifier for the physical instance, typically a serial number

.... lotNumber 0..1stringThe lot or batch number of the item
.... expiry 0..1dateTimeThe expiry date or date and time for the product
.... subject 0..1Reference(Patient | Organization)The subject that the item is associated with
.... location 0..1Reference(Location)The location that the item is associated with
... productReference 0..1Reference(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

UML Diagram (Legend)

InventoryItem (DomainResource)Business identifier for the inventory itemidentifier : Identifier [0..*]Status of the item entrystatus : code [1..1] « A coded concept specifying the status of the inventory item. (Strength=Required)InventoryItemStatusCodes! »Category or class of the itemcategory : CodeableConcept [0..*]Code designating the specific type of itemcode : CodeableConcept [0..*]The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etcinventoryStatus : CodeableConcept [0..*]The base unit of measure - the unit in which the product is used or countedbaseUnit : CodeableConcept [0..1]Net content or amount present in the itemnetContent : Quantity(SimpleQuantity) [0..1]Link to a product resource used in clinical workflowsproductReference : Reference [0..1] « Medication|Device| NutritionProduct|BiologicallyDerivedProduct »NameThe type of name e.g. 'brand-name', 'functional-name', 'common-name'nameType : Coding [1..1] « The type of name for the item (Strength=Preferred)InventoryItemStatusCodes? »The language that the item name is expressed inlanguage : code [1..1] « The languages for an item name (Strength=Required)CommonLanguages! »The name or designation that the item is givenname : string [1..1]ResponsibleOrganizationThe role of the organization e.g. manufacturer, distributor, etcrole : CodeableConcept [1..1]An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etcorganization : Reference [1..1] « Organization »DescriptionThe language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' languagelanguage : code [0..1] « The languages for a description of an item (Strength=Required)CommonLanguages! »Textual description of the itemdescription : string [0..1]AssociationThis attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed withassociationType : CodeableConcept [1..1]The related item or productrelatedItem : Reference [1..1] « InventoryItem|Medication| MedicationKnowledge|Device|DeviceDefinition|NutritionProduct| BiologicallyDerivedProduct »The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present productquantity : Ratio [1..1]CharacteristicThe type of characteristic that is being definedcharacteristicType : CodeableConcept [1..1]The value of the attributevalue[x] : DataType [1..1] « string|integer|decimal|boolean|url| dateTime|Quantity|Range|Ratio|Annotation|Address|Duration| CodeableConcept »InstanceThe identifier for the physical instance, typically a serial numberidentifier : Identifier [0..*]The lot or batch number of the itemlotNumber : string [0..1]The expiry date or date and time for the productexpiry : dateTime [0..1]The subject that the item is associated withsubject : Reference [0..1] « Patient|Organization »The location that the item is associated withlocation : Reference [0..1] « Location »The item name(s) - the brand name, or common name, functional name, generic namename[0..*]Organization(s) responsible for the productresponsibleOrganization[0..*]The descriptive characteristics of the inventory itemdescription[0..1]Association with other items or productsassociation[0..*]The descriptive or identifying characteristics of the itemcharacteristic[0..*]Instances or occurrences of the productinstance[0..1]

XML Template

<InventoryItem xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem DDomainResourceA 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..*IdentifierBusiness identifier for the inventory item

... status Σ1..1codeactive | inactive | entered-in-error | unknown
Binding: InventoryItem Status Codes (Required)
... category Σ0..*CodeableConceptCategory or class of the item

... name Σ0..*BackboneElementThe item name(s) - the brand name, or common name, functional name, generic name or others

.... nameType Σ1..1CodingThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
Binding: InventoryItem Name Typess (Preferred)
.... language Σ1..1codeThe language used to express the item name
Binding: Common Languages (Required)
.... name Σ1..1stringThe name or designation of the item
... responsibleOrganization 0..*BackboneElementOrganization(s) responsible for the product

.... role 1..1CodeableConceptThe role of the organization e.g. manufacturer, distributor, or other
.... organization 1..1Reference(Organization)An organization that is associated with the item
... description 0..1BackboneElementDescriptive characteristics of the item
.... language 0..1codeThe language that is used in the item description
Binding: Common Languages (Required)
.... description 0..1stringTextual description of the item
... inventoryStatus Σ0..*CodeableConceptThe usage status like recalled, in use, discarded

... baseUnit Σ0..1CodeableConceptThe base unit of measure - the unit in which the product is used or counted
... netContent Σ0..1SimpleQuantityNet content or amount present in the item
... association 0..*BackboneElementAssociation with other items or products

.... associationType Σ1..1CodeableConceptThe type of association between the device and the other item
.... relatedItem Σ1..1Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct)The related item or product
.... quantity Σ1..1RatioThe quantity of the product in this product
... characteristic 0..*BackboneElementCharacteristic of the item

.... characteristicType 1..1CodeableConceptThe characteristic that is being defined
.... value[x] 1..1The value of the attribute
..... valueStringstring
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBooleanboolean
..... valueUrlurl
..... valueDateTimedateTime
..... valueQuantityQuantity
..... valueRangeRange
..... valueRatioRatio
..... valueAnnotationAnnotation
..... valueAddressAddress
..... valueDurationDuration
..... valueCodeableConceptCodeableConcept
... instance 0..1BackboneElementInstances or occurrences of the product
.... identifier 0..*IdentifierThe identifier for the physical instance, typically a serial number

.... lotNumber 0..1stringThe lot or batch number of the item
.... expiry 0..1dateTimeThe expiry date or date and time for the product
.... subject 0..1Reference(Patient | Organization)The subject that the item is associated with
.... location 0..1Reference(Location)The location that the item is associated with
... productReference 0..1Reference(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

UML Diagram (Legend)

InventoryItem (DomainResource)Business identifier for the inventory itemidentifier : Identifier [0..*]Status of the item entrystatus : code [1..1] « A coded concept specifying the status of the inventory item. (Strength=Required)InventoryItemStatusCodes! »Category or class of the itemcategory : CodeableConcept [0..*]Code designating the specific type of itemcode : CodeableConcept [0..*]The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etcinventoryStatus : CodeableConcept [0..*]The base unit of measure - the unit in which the product is used or countedbaseUnit : CodeableConcept [0..1]Net content or amount present in the itemnetContent : Quantity(SimpleQuantity) [0..1]Link to a product resource used in clinical workflowsproductReference : Reference [0..1] « Medication|Device| NutritionProduct|BiologicallyDerivedProduct »NameThe type of name e.g. 'brand-name', 'functional-name', 'common-name'nameType : Coding [1..1] « The type of name for the item (Strength=Preferred)InventoryItemStatusCodes? »The language that the item name is expressed inlanguage : code [1..1] « The languages for an item name (Strength=Required)CommonLanguages! »The name or designation that the item is givenname : string [1..1]ResponsibleOrganizationThe role of the organization e.g. manufacturer, distributor, etcrole : CodeableConcept [1..1]An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etcorganization : Reference [1..1] « Organization »DescriptionThe language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' languagelanguage : code [0..1] « The languages for a description of an item (Strength=Required)CommonLanguages! »Textual description of the itemdescription : string [0..1]AssociationThis attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed withassociationType : CodeableConcept [1..1]The related item or productrelatedItem : Reference [1..1] « InventoryItem|Medication| MedicationKnowledge|Device|DeviceDefinition|NutritionProduct| BiologicallyDerivedProduct »The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present productquantity : Ratio [1..1]CharacteristicThe type of characteristic that is being definedcharacteristicType : CodeableConcept [1..1]The value of the attributevalue[x] : DataType [1..1] « string|integer|decimal|boolean|url| dateTime|Quantity|Range|Ratio|Annotation|Address|Duration| CodeableConcept »InstanceThe identifier for the physical instance, typically a serial numberidentifier : Identifier [0..*]The lot or batch number of the itemlotNumber : string [0..1]The expiry date or date and time for the productexpiry : dateTime [0..1]The subject that the item is associated withsubject : Reference [0..1] « Patient|Organization »The location that the item is associated withlocation : Reference [0..1] « Location »The item name(s) - the brand name, or common name, functional name, generic namename[0..*]Organization(s) responsible for the productresponsibleOrganization[0..*]The descriptive characteristics of the inventory itemdescription[0..1]Association with other items or productsassociation[0..*]The descriptive or identifying characteristics of the itemcharacteristic[0..*]Instances or occurrences of the productinstance[0..1]

XML Template

<InventoryItem xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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

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

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.

NameTypeDescriptionExpressionIn Common
code TUtokenSearch for products that match this codeInventoryItem.code
identifier TUtokenThe identifier of the itemInventoryItem.identifier
status TUtokenThe status of the itemInventoryItem.status
subject TUreferenceThe identity of a patient for whom to list associationsInventoryItem.instance.subject
(Organization, Patient)