OO Incubator Implementation Guide
0.1.0 - ci-build Global (Whole world)

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: Trial-use Maturity Level: 1 Computable Name: InventoryItem
Other Identifiers: OID:2.16.840.1.113883.4.642.40.98.42.5

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

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.

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
This resource is an additional resource
InventoryItem.identifier This element is included in summaries. 0..* Identifier Business identifier for the inventory item
InventoryItem.status This element is included in summaries. 1..1 code active | inactive | entered-in-error | unknown
Binding: InventoryItem Status Codes Values (required): Status of the inventory item.
InventoryItem.category This element is included in summaries. 0..* CodeableConcept Category or class of the item
InventoryItem.classification.type This element is included in summaries. 1..1 CodeableConcept A classification of the inventory item
InventoryItem.classification.justification 0..* RelatedArtifact Further information qualifying this classification of the inventoryItem
InventoryItem.code This element is included in summaries. 0..* CodeableConcept Code designating the specific type of item
InventoryItem.name This element is included in summaries. 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
InventoryItem.name.nameType This element is included in summaries. 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name'
Binding: InventoryItem Name Types Values (preferred): Name types.
InventoryItem.name.language This element is included in summaries. 1..1 code The language used to express the item name
Binding: AllLanguages (preferred): Name languages.
InventoryItem.name.name This element is included in summaries. 1..1 string The name or designation of the item
InventoryItem.responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
InventoryItem.responsibleOrganization.role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
InventoryItem.responsibleOrganization.organization 1..1 Reference(Organization) An organization that is associated with the item
InventoryItem.description 0..1 BackboneElement Descriptive characteristics of the item
InventoryItem.description.language 0..1 code The language that is used in the item description
Binding: AllLanguages (preferred): Description languages.
InventoryItem.description.description 0..1 string Textual description of the item
InventoryItem.inventoryStatus This element is included in summaries. 0..* CodeableConcept The usage status like recalled, in use, discarded
InventoryItem.baseUnit This element is included in summaries. 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted
InventoryItem.netContent This element is included in summaries. 0..1 SimpleQuantity Net content or amount present in the item
InventoryItem.association 0..* BackboneElement Association with other items or products
InventoryItem.association.associationType This element is included in summaries. 1..1 CodeableConcept The type of association between the device and the other item
InventoryItem.association.relatedItem This element is included in summaries. 1..1 Reference(InventoryItem | Medication | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product
InventoryItem.association.quantity This element is included in summaries. 1..1 Ratio The quantity of the product in this product
InventoryItem.characteristic 0..* BackboneElement Characteristic of the item
InventoryItem.characteristic.characteristicType 1..1 CodeableConcept The characteristic that is being defined
InventoryItem.characteristic.value[x] 1..1 The value of the attribute
InventoryItem.characteristic.value[x].valueString string
InventoryItem.characteristic.value[x].valueInteger integer
InventoryItem.characteristic.value[x].valueDecimal decimal
InventoryItem.characteristic.value[x].valueBoolean boolean
InventoryItem.characteristic.value[x].valueUrl url
InventoryItem.characteristic.value[x].valueDateTime dateTime
InventoryItem.characteristic.value[x].valueQuantity Quantity
InventoryItem.characteristic.value[x].valueRange Range
InventoryItem.characteristic.value[x].valueRatio Ratio
InventoryItem.characteristic.value[x].valueAnnotation Annotation
InventoryItem.characteristic.value[x].valueAddress Address
InventoryItem.characteristic.value[x].valueDuration Duration
InventoryItem.characteristic.value[x].valueCodeableConcept CodeableConcept
InventoryItem.instance 0..1 BackboneElement Instances or occurrences of the product
InventoryItem.instance.identifier 0..* Identifier The identifier for the physical instance, typically a serial number
InventoryItem.instance.lotNumber 0..1 string The lot or batch number of the item
InventoryItem.instance.expiry 0..1 dateTime The expiry date or date and time for the product
InventoryItem.instance.subject 0..1 Reference(Patient | Organization | Group) The subject that the item is associated with
InventoryItem.instance.location 0..1 Reference(Location) The location that the item is associated with
InventoryItem.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 Values 📦0.1.0 This IG
InventoryItem.name.nameType Base preferred InventoryItem Name Types Values 📦0.1.0 This IG
InventoryItem.name.language Base preferred All Languages 📦6.0.0-snapshot1 FHIR Std.
InventoryItem.description.​language Base preferred All Languages 📦6.0.0-snapshot1 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>
 <classification> I 0..* *  <!-- I 0..* What kind of inventory item this is -->
  <id value="[string]"/><!-- 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>
  <type><!-- 1..1 * A classification of the inventory item   --></type>
  <justification><!-- 0..* * Further information qualifying this classification of the inventoryItem   --></justification>
 </classification>
 <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="[string]"/><!-- 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="[string]"/><!-- 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="[string]"/><!-- 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="[string]"/><!-- 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="[string]"/><!-- 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="[string]"/><!-- 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
  "classification" : [{ BackboneElement }], // I 0..* What kind of inventory item this is
    "id" : "<string>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "type" : { CodeableConcept }, // 1..1 A classification of the inventory item
    "justification" : [{ RelatedArtifact }] // 0..* Further information qualifying this classification of the inventoryItem
  }
  "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" : "<string>", // 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" : "<string>", // 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" : "<string>", // 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" : "<string>", // 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|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" : "<string>", // 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" : "<string>", // 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:classification  ( [ BackboneElement ] ... ) ; # 0..* I What kind of inventory item this is
  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

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
This resource is an additional resource
InventoryItem.identifier This element is included in summaries. 0..* Identifier Business identifier for the inventory item
InventoryItem.status This element is included in summaries. 1..1 code active | inactive | entered-in-error | unknown
Binding: InventoryItem Status Codes Values (required): Status of the inventory item.
InventoryItem.category This element is included in summaries. 0..* CodeableConcept Category or class of the item
InventoryItem.classification This element is included in summaries. 0..* BackboneElement What kind of inventory item this is
InventoryItem.classification.type This element is included in summaries. 1..1 CodeableConcept A classification of the inventory item
InventoryItem.classification.justification 0..* RelatedArtifact Further information qualifying this classification of the inventoryItem
InventoryItem.code This element is included in summaries. 0..* CodeableConcept Code designating the specific type of item
InventoryItem.name This element is included in summaries. 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
InventoryItem.name.nameType This element is included in summaries. 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name'
Binding: InventoryItem Name Types Values (preferred): Name types.
InventoryItem.name.language This element is included in summaries. 1..1 code The language used to express the item name
Binding: AllLanguages (preferred): Name languages.
InventoryItem.name.name This element is included in summaries. 1..1 string The name or designation of the item
InventoryItem.responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
InventoryItem.responsibleOrganization.role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
InventoryItem.responsibleOrganization.organization 1..1 Reference(Organization) An organization that is associated with the item
InventoryItem.description 0..1 BackboneElement Descriptive characteristics of the item
InventoryItem.description.language 0..1 code The language that is used in the item description
Binding: AllLanguages (preferred): Description languages.
InventoryItem.description.description 0..1 string Textual description of the item
InventoryItem.inventoryStatus This element is included in summaries. 0..* CodeableConcept The usage status like recalled, in use, discarded
InventoryItem.baseUnit This element is included in summaries. 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted
InventoryItem.netContent This element is included in summaries. 0..1 SimpleQuantity Net content or amount present in the item
InventoryItem.association 0..* BackboneElement Association with other items or products
InventoryItem.association.associationType This element is included in summaries. 1..1 CodeableConcept The type of association between the device and the other item
InventoryItem.association.relatedItem This element is included in summaries. 1..1 Reference(InventoryItem | Medication | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product
InventoryItem.association.quantity This element is included in summaries. 1..1 Ratio The quantity of the product in this product
InventoryItem.characteristic 0..* BackboneElement Characteristic of the item
InventoryItem.characteristic.characteristicType 1..1 CodeableConcept The characteristic that is being defined
InventoryItem.characteristic.value[x] 1..1 The value of the attribute
InventoryItem.characteristic.value[x].valueString string
InventoryItem.characteristic.value[x].valueInteger integer
InventoryItem.characteristic.value[x].valueDecimal decimal
InventoryItem.characteristic.value[x].valueBoolean boolean
InventoryItem.characteristic.value[x].valueUrl url
InventoryItem.characteristic.value[x].valueDateTime dateTime
InventoryItem.characteristic.value[x].valueQuantity Quantity
InventoryItem.characteristic.value[x].valueRange Range
InventoryItem.characteristic.value[x].valueRatio Ratio
InventoryItem.characteristic.value[x].valueAnnotation Annotation
InventoryItem.characteristic.value[x].valueAddress Address
InventoryItem.characteristic.value[x].valueDuration Duration
InventoryItem.characteristic.value[x].valueCodeableConcept CodeableConcept
InventoryItem.instance 0..1 BackboneElement Instances or occurrences of the product
InventoryItem.instance.identifier 0..* Identifier The identifier for the physical instance, typically a serial number
InventoryItem.instance.lotNumber 0..1 string The lot or batch number of the item
InventoryItem.instance.expiry 0..1 dateTime The expiry date or date and time for the product
InventoryItem.instance.subject 0..1 Reference(Patient | Organization | Group) The subject that the item is associated with
InventoryItem.instance.location 0..1 Reference(Location) The location that the item is associated with
InventoryItem.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 Values 📦0.1.0 This IG
InventoryItem.name.nameType Base preferred InventoryItem Name Types Values 📦0.1.0 This IG
InventoryItem.name.language Base preferred All Languages 📦6.0.0-snapshot1 FHIR Std.
InventoryItem.description.​language Base preferred All Languages 📦6.0.0-snapshot1 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
type token

The type of inventory item

 InventoryItem.classification.type