R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Orders and Observations icon Work GroupMaturity Level: 0 DraftSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the InventoryItem resource.

InventoryItem
Element IdInventoryItem
Definition

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

Short DisplayA functional description of an inventory item used in inventory and supply-related workflows
Cardinality0..*
TypeDomainResource
Summaryfalse
InventoryItem.identifier
Element IdInventoryItem.identifier
Definition

Business identifier for the inventory item.

Short DisplayBusiness identifier for the inventory item
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
InventoryItem.status
Element IdInventoryItem.status
Definition

Status of the item entry.

Short Displayactive | inactive | entered-in-error | unknown
Cardinality1..1
Terminology BindingInventoryItem Status Codes (Required)
Typecode
Summarytrue
InventoryItem.category
Element IdInventoryItem.category
Definition

Category or class of the item.

Short DisplayCategory or class of the item
Cardinality0..*
TypeCodeableConcept
Summarytrue
InventoryItem.code
Element IdInventoryItem.code
Definition

Code designating the specific type of item.

Short DisplayCode designating the specific type of item
Cardinality0..*
TypeCodeableConcept
Summarytrue
InventoryItem.name
Element IdInventoryItem.name
Definition

The item name(s) - the brand name, or common name, functional name, generic name.

Short DisplayThe item name(s) - the brand name, or common name, functional name, generic name or others
Cardinality0..*
Summarytrue
InventoryItem.name.nameType
Element IdInventoryItem.name.nameType
Definition

The type of name e.g. 'brand-name', 'functional-name', 'common-name'.

Short DisplayThe type of name e.g. 'brand-name', 'functional-name', 'common-name'
Cardinality1..1
Terminology BindingInventoryItem Name Typess (Preferred)
TypeCoding
Summarytrue
InventoryItem.name.language
Element IdInventoryItem.name.language
Definition

The language that the item name is expressed in.

Short DisplayThe language used to express the item name
Cardinality1..1
Terminology BindingCommon Languages (Required)
Typecode
Summarytrue
InventoryItem.name.name
Element IdInventoryItem.name.name
Definition

The name or designation that the item is given.

Short DisplayThe name or designation of the item
Cardinality1..1
Typestring
Summarytrue
InventoryItem.responsibleOrganization
Element IdInventoryItem.responsibleOrganization
Definition

Organization(s) responsible for the product.

Short DisplayOrganization(s) responsible for the product
Cardinality0..*
Summaryfalse
InventoryItem.responsibleOrganization.role
Element IdInventoryItem.responsibleOrganization.role
Definition

The role of the organization e.g. manufacturer, distributor, etc.

Short DisplayThe role of the organization e.g. manufacturer, distributor, or other
Cardinality1..1
TypeCodeableConcept
Summaryfalse
InventoryItem.responsibleOrganization.organization
Element IdInventoryItem.responsibleOrganization.organization
Definition

An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etc.

Short DisplayAn organization that is associated with the item
Cardinality1..1
TypeReference(Organization)
Summaryfalse
InventoryItem.description
Element IdInventoryItem.description
Definition

The descriptive characteristics of the inventory item.

Short DisplayDescriptive characteristics of the item
Cardinality0..1
Summaryfalse
InventoryItem.description.language
Element IdInventoryItem.description.language
Definition

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

Short DisplayThe language that is used in the item description
Cardinality0..1
Terminology BindingCommon Languages (Required)
Typecode
Summaryfalse
InventoryItem.description.description
Element IdInventoryItem.description.description
Definition

Textual description of the item.

Short DisplayTextual description of the item
Cardinality0..1
Typestring
Summaryfalse
InventoryItem.inventoryStatus
Element IdInventoryItem.inventoryStatus
Definition

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

Short DisplayThe usage status like recalled, in use, discarded
Cardinality0..*
TypeCodeableConcept
Summarytrue
InventoryItem.baseUnit
Element IdInventoryItem.baseUnit
Definition

The base unit of measure - the unit in which the product is used or counted.

Short DisplayThe base unit of measure - the unit in which the product is used or counted
Cardinality0..1
TypeCodeableConcept
Summarytrue
InventoryItem.netContent
Element IdInventoryItem.netContent
Definition

Net content or amount present in the item.

Short DisplayNet content or amount present in the item
Cardinality0..1
TypeSimpleQuantity
Summarytrue
InventoryItem.association
Element IdInventoryItem.association
Definition

Association with other items or products.

Short DisplayAssociation with other items or products
Cardinality0..*
Summaryfalse
InventoryItem.association.associationType
Element IdInventoryItem.association.associationType
Definition

This attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed with.

Short DisplayThe type of association between the device and the other item
Cardinality1..1
TypeCodeableConcept
Summarytrue
InventoryItem.association.relatedItem
Element IdInventoryItem.association.relatedItem
Definition

The related item or product.

Short DisplayThe related item or product
Cardinality1..1
TypeReference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct)
Summarytrue
InventoryItem.association.quantity
Element IdInventoryItem.association.quantity
Definition

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

Short DisplayThe quantity of the product in this product
Cardinality1..1
TypeRatio
Summarytrue
InventoryItem.characteristic
Element IdInventoryItem.characteristic
Definition

The descriptive or identifying characteristics of the item.

Short DisplayCharacteristic of the item
Cardinality0..*
Summaryfalse
InventoryItem.characteristic.characteristicType
Element IdInventoryItem.characteristic.characteristicType
Definition

The type of characteristic that is being defined.

Short DisplayThe characteristic that is being defined
Cardinality1..1
TypeCodeableConcept
Summaryfalse
InventoryItem.characteristic.value[x]
Element IdInventoryItem.characteristic.value[x]
Definition

The value of the attribute.

Short DisplayThe value of the attribute
Cardinality1..1
Typestring|integer|decimal|boolean|url|dateTime|Quantity|Range|Ratio|Annotation|Address|Duration|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

The string value is used for characteristics that are descriptive and not codeable information. CodeableConcept.text is used when the characteristic is discrete and could otherwise be coded but for which there is no code available.

InventoryItem.instance
Element IdInventoryItem.instance
Definition

Instances or occurrences of the product.

Short DisplayInstances or occurrences of the product
Cardinality0..1
Summaryfalse
InventoryItem.instance.identifier
Element IdInventoryItem.instance.identifier
Definition

The identifier for the physical instance, typically a serial number.

Short DisplayThe identifier for the physical instance, typically a serial number
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
InventoryItem.instance.lotNumber
Element IdInventoryItem.instance.lotNumber
Definition

The lot or batch number of the item.

Short DisplayThe lot or batch number of the item
Cardinality0..1
Typestring
Summaryfalse
InventoryItem.instance.expiry
Element IdInventoryItem.instance.expiry
Definition

The expiry date or date and time for the product.

Short DisplayThe expiry date or date and time for the product
Cardinality0..1
TypedateTime
Summaryfalse
InventoryItem.instance.subject
Element IdInventoryItem.instance.subject
Definition

The subject that the item is associated with.

Short DisplayThe subject that the item is associated with
Cardinality0..1
TypeReference(Patient | Organization)
Summaryfalse
InventoryItem.instance.location
Element IdInventoryItem.instance.location
Definition

The location that the item is associated with.

Short DisplayThe location that the item is associated with
Cardinality0..1
TypeReference(Location)
Summaryfalse
InventoryItem.productReference
Element IdInventoryItem.productReference
Definition

Link to a product resource used in clinical workflows.

Short DisplayLink to a product resource used in clinical workflows
Cardinality0..1
TypeReference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct)
Summaryfalse