OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: InventoryItem

Official URL: http://hl7.org/fhir/StructureDefinition/InventoryItem Version: 0.1.0
Standards status: Draft Draft as of 2021-01-02 Maturity Level: 0 Computable Name: InventoryItem

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* 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: InventoryItemStatusCodes (required): Status of the inventory item.
... 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: InventoryItemStatusCodes (preferred): Name types.
.... language Σ 1..1 code The language used to express the item name
Binding: CommonLanguages (required): Name languages.
.... 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: CommonLanguages (required): Description languages.
.... 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 | Group) 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InventoryItem.status Base required InventoryItem Status Codes 📦6.0.0-ballot3 FHIR Std.
InventoryItem.name.nameType Base preferred InventoryItem Name Typess 📦6.0.0-ballot3 FHIR Std.
InventoryItem.name.language Base required Common Languages 📦6.0.0-ballot3 FHIR Std.
InventoryItem.description.​language Base required Common Languages 📦6.0.0-ballot3 FHIR Std. 
​
<InventoryItem xmlns="http://hl7.org/fhir"> ​​doco
 ​<id value="[id]"/><!-- 0..1 ​* ​Logical id of this artifact  -->
 ​<meta><!-- ​I 0..1 ​* ​Metadata about the resource  --></meta>
 ​<implicitRules value="[uri]"/><!-- ​I 0..1 ​* ​A set of rules under which this content was created  -->
 ​<language value="[code]"/><!-- ​I 0..1 ​* Language of the resource content  -->
 ​<text><!-- ​I 0..1 ​* ​Text summary of the resource, for human interpretation  --></text>
 ​<contained><!-- 0..* ​* ​Contained, inline Resources  --></contained>
 ​<extension><!-- See Extensions  ​Additional content defined by implementations  --></extension>
 ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* ​* ​Business identifier for the inventory item  --></identifier>
 <status value="[code]"/><!-- 1..1 ​* active | inactive | entered-in-error | unknown  -->
 <category><!-- 0..* ​* ​Category or class of the item  --></category>
 <code><!-- 0..* ​* ​Code designating the specific type of item  --></code>
 <name> ​I 0..* ​*  <!-- ​I 0..* The item name(s) - the brand name, or common name, functional name, generic name or others -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <nameType><!-- 1..1 ​* 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> ​I 0..* ​*  <!-- ​I 0..* Organization(s) responsible for the product -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <role><!-- 1..1 ​* ​The role of the organization e.g. manufacturer, distributor, or other   --></role>
  <organization><!-- 1..1 ​* ​An organization that is associated with the item   --></organization>
 </responsibleOrganization>
 <description> ​I 0..1 ​*  <!-- ​I 0..1 Descriptive characteristics of the item -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <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..* ​* ​The usage status like recalled, in use, discarded  --></inventoryStatus>
 <baseUnit><!-- 0..1 ​* ​The base unit of measure - the unit in which the product is used or counted  --></baseUnit>
 <netContent><!-- 0..1 ​* ​Net content or amount present in the item  --></netContent>
 <association> ​I 0..* ​*  <!-- ​I 0..* Association with other items or products -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <associationType><!-- 1..1 ​* ​The type of association between the device and the other item   --></associationType>
  <relatedItem><!-- 1..1 ​* ​The related item or product   --></relatedItem>
  <quantity><!-- 1..1 ​* ​The quantity of the product in this product   --></quantity>
 </association>
 <characteristic> ​I 0..* ​*  <!-- ​I 0..* Characteristic of the item -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <characteristicType><!-- 1..1 ​* ​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> ​I 0..1 ​*  <!-- ​I 0..1 Instances or occurrences of the product -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <identifier><!-- 0..* ​* ​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 ​* ​The subject that the item is associated with   --></subject>
  <location><!-- 0..1 ​* ​The location that the item is associated with   --></location>
 </instance>
 <productReference><!-- 0..1 ​* ​Link to a product resource used in clinical workflows  --></productReference>
</InventoryItem>

​
{​​doco
  "resourceType" : "InventoryItem",
  "id" : "<id>", // 0..1 ​Logical id of this artifact
  "meta" : { Meta }, // ​I 0..1 ​Metadata about the resource
  "implicitRules" : "<uri>", // ​I 0..1 ​A set of rules under which this content was created
  "language" : "<code>", // ​I 0..1 Language of the resource content
  "text" : { Narrative }, // ​I 0..1 ​Text summary of the resource, for human interpretation
  "contained" : [{ ​Resource }], // 0..* ​Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* ​Business identifier for the inventory item
  "status" : "<code>", // 1..1 active | inactive | entered-in-error | unknown
  "category" : [{ CodeableConcept }], // 0..* ​Category or class of the item
  "code" : [{ CodeableConcept }], // 0..* ​Code designating the specific type of item
  "name" : [{ BackboneElement }], // ​I 0..* ​The item name(s) - the brand name, or common name, functional name, generic name or others
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "nameType" : { Coding }, // 1..1 The type of name e.g. 'brand-name', 'functional-name', 'common-name'
    "language" : "<code>", // 1..1 The language used to express the item name
    "name" : "<string>" // 1..1 ​The name or designation of the item
  }
  "responsibleOrganization" : [{ BackboneElement }], // ​I 0..* ​Organization(s) responsible for the product
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "role" : { CodeableConcept }, // 1..1 ​The role of the organization e.g. manufacturer, distributor, or other
    "organization" : { Reference(Organization) } // 1..1 ​An organization that is associated with the item
  }
  "description" : { BackboneElement }, // ​I 0..1 ​Descriptive characteristics of the item
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "language" : "<code>", // 0..1 The language that is used in the item description
    "description" : "<string>" // 0..1 ​Textual description of the item
  }
  "inventoryStatus" : [{ CodeableConcept }], // 0..* ​The usage status like recalled, in use, discarded
  "baseUnit" : { CodeableConcept }, // 0..1 ​The base unit of measure - the unit in which the product is used or counted
  "netContent" : { Quantity }, // 0..1 ​Net content or amount present in the item
  "association" : [{ BackboneElement }], // ​I 0..* ​Association with other items or products
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "associationType" : { CodeableConcept }, // 1..1 ​The type of association between the device and the other item
    "relatedItem" : { Reference(BiologicallyDerivedProduct|Device|
    DeviceDefinition|InventoryItem|Medication|MedicationKnowledge|
    NutritionProduct) }, // 1..1 ​The related item or product
    "quantity" : { Ratio } // 1..1 ​The quantity of the product in this product
  }
  "characteristic" : [{ BackboneElement }], // ​I 0..* ​Characteristic of the item
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "characteristicType" : { CodeableConcept }, // 1..1 ​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" : { BackboneElement }, // ​I 0..1 ​Instances or occurrences of the product
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "identifier" : [{ Identifier }], // 0..* ​The identifier for the physical instance, typically a serial number
    "lotNumber" : "<string>", // 0..1 ​The lot or batch number of the item
    "expiry" : "<dateTime>", // 0..1 ​The expiry date or date and time for the product
    "subject" : { Reference(Group|Organization|Patient) }, // 0..1 ​The subject that the item is associated with
    "location" : { Reference(Location) } // 0..1 ​The location that the item is associated with
  }
  "productReference" : { Reference(BiologicallyDerivedProduct|Device|
   Medication|NutritionProduct) } // 0..1 ​Link to a product resource used in clinical workflows
}

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


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

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 ​I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 ​I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 ​I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 ​I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* ​I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* ​I Extensions that cannot be ignored
  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  ( [ BackboneElement ] ... ) ; # 0..* ​I The item name(s) - the brand name, or common name, functional name, generic name or others
  fhir:responsibleOrganization  ( [ BackboneElement ] ... ) ; # 0..* ​I Organization(s) responsible for the product
  fhir:description [ BackboneElement ] ; # 0..1 ​I Descriptive characteristics 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 ] ; # 0..1 Net content or amount present in the item
  fhir:association  ( [ BackboneElement ] ... ) ; # 0..* ​I Association with other items or products
  fhir:characteristic  ( [ BackboneElement ] ... ) ; # 0..* ​I Characteristic of the item
  fhir:instance [ BackboneElement ] ; # 0..1 ​I Instances or occurrences of the product
  fhir:productReference [ Reference(BiologicallyDerivedProduct|Device|Medication|NutritionProduct) ] ; # 0..1 Link to a product resource used in clinical workflows
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* 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: InventoryItemStatusCodes (required): Status of the inventory item.
... 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: InventoryItemStatusCodes (preferred): Name types.
.... language Σ 1..1 code The language used to express the item name
Binding: CommonLanguages (required): Name languages.
.... 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: CommonLanguages (required): Description languages.
.... 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 | Group) 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InventoryItem.status Base required InventoryItem Status Codes 📦6.0.0-ballot3 FHIR Std.
InventoryItem.name.nameType Base preferred InventoryItem Name Typess 📦6.0.0-ballot3 FHIR Std.
InventoryItem.name.language Base required Common Languages 📦6.0.0-ballot3 FHIR Std.
InventoryItem.description.​language Base required Common Languages 📦6.0.0-ballot3 FHIR Std.

 

Other representations of resource: CSV, Excel

Notes:

[%stu-note dstu2%]

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

[%end-note%]
Name Type Description Expression
code token

Search for products that match this code

 InventoryItem.code
identifier token

The identifier of the item

 InventoryItem.identifier
status token

The status of the item

 InventoryItem.status
subject reference

The identity of a patient for whom to list associations

 InventoryItem.instance.subject