View raw Markdown
type: resource-definitionsresource: InventoryItem

InventoryItem Definitions

<a id="InventoryItem"></a>

InventoryItem

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

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

Cardinality: 0..*

Mappings: w5=administrative.entity

<a id="InventoryItem.identifier"></a>

InventoryItem.identifier

Business identifier for the inventory item

Definition: Business identifier for the inventory item.

Cardinality: 0..*

Type: Identifier

Summary: true

<a id="InventoryItem.status"></a>

InventoryItem.status

active | inactive | entered-in-error | unknown

Definition: Status of the item entry.

Cardinality: 1..1

Type: code

Binding: required:inventoryitem-status

Summary: true

<a id="InventoryItem.category"></a>

InventoryItem.category

Category or class of the item

Definition: Category or class of the item.

Cardinality: 0..*

Type: CodeableConcept

Summary: true

<a id="InventoryItem.code"></a>

InventoryItem.code

Code designating the specific type of item

Definition: Code designating the specific type of item.

Cardinality: 0..*

Type: CodeableConcept

Summary: true

<a id="InventoryItem.name"></a>

InventoryItem.name

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

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

Cardinality: 0..*

Type: BackboneElement

Summary: true

<a id="InventoryItem.name.nameType"></a>

InventoryItem.name.nameType

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

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

Cardinality: 1..1

Type: Coding

Binding: preferred:inventoryitem-nametype

Summary: true

<a id="InventoryItem.name.language"></a>

InventoryItem.name.language

The language used to express the item name

Definition: The language that the item name is expressed in.

Cardinality: 1..1

Type: code

Binding: required:languages

Summary: true

<a id="InventoryItem.name.name"></a>

InventoryItem.name.name

The name or designation of the item

Definition: The name or designation that the item is given.

Cardinality: 1..1

Type: string

Summary: true

<a id="InventoryItem.responsibleOrganization"></a>

InventoryItem.responsibleOrganization

Organization(s) responsible for the product

Definition: Organization(s) responsible for the product.

Cardinality: 0..*

Type: BackboneElement

<a id="InventoryItem.responsibleOrganization.role"></a>

InventoryItem.responsibleOrganization.role

The role of the organization e.g. manufacturer, distributor, or other

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

Cardinality: 1..1

Type: CodeableConcept

<a id="InventoryItem.responsibleOrganization.organization"></a>

InventoryItem.responsibleOrganization.organization

An organization that is associated with the item

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

Cardinality: 1..1

Type: Reference(Organization)

<a id="InventoryItem.description"></a>

InventoryItem.description

Descriptive characteristics of the item

Definition: The descriptive characteristics of the inventory item.

Cardinality: 0..1

Type: BackboneElement

<a id="InventoryItem.description.language"></a>

InventoryItem.description.language

The language that is used in the item description

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.

Cardinality: 0..1

Type: code

Binding: required:languages

<a id="InventoryItem.description.description"></a>

InventoryItem.description.description

Textual description of the item

Definition: Textual description of the item.

Cardinality: 0..1

Type: string

<a id="InventoryItem.inventoryStatus"></a>

InventoryItem.inventoryStatus

The usage status like recalled, in use, discarded

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.

Cardinality: 0..*

Type: CodeableConcept

Summary: true

<a id="InventoryItem.baseUnit"></a>

InventoryItem.baseUnit

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

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

Cardinality: 0..1

Type: CodeableConcept

Summary: true

<a id="InventoryItem.netContent"></a>

InventoryItem.netContent

Net content or amount present in the item

Definition: Net content or amount present in the item.

Cardinality: 0..1

Type: Quantity(SimpleQuantity)

Summary: true

<a id="InventoryItem.association"></a>

InventoryItem.association

Association with other items or products

Definition: Association with other items or products.

Cardinality: 0..*

Type: BackboneElement

<a id="InventoryItem.association.associationType"></a>

InventoryItem.association.associationType

The type of association between the device and the other item

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.

Cardinality: 1..1

Type: CodeableConcept

Summary: true

<a id="InventoryItem.association.relatedItem"></a>

InventoryItem.association.relatedItem

The related item or product

Definition: The related item or product.

Cardinality: 1..1

Type: Reference(InventoryItem, Medication, Device, DeviceDefinition, NutritionProduct, BiologicallyDerivedProduct)

Summary: true

<a id="InventoryItem.association.quantity"></a>

InventoryItem.association.quantity

The quantity of the product in this product

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.

Cardinality: 1..1

Type: Ratio

Summary: true

<a id="InventoryItem.characteristic"></a>

InventoryItem.characteristic

Characteristic of the item

Definition: The descriptive or identifying characteristics of the item.

Cardinality: 0..*

Type: BackboneElement

<a id="InventoryItem.characteristic.characteristicType"></a>

InventoryItem.characteristic.characteristicType

The characteristic that is being defined

Definition: The type of characteristic that is being defined.

Cardinality: 1..1

Type: CodeableConcept

<a id="InventoryItem.characteristic.value[x]"></a>

InventoryItem.characteristic.value[x]

The value of the attribute

Definition: The value of the attribute.

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.

Cardinality: 1..1

Type: string, integer, decimal, boolean, url, dateTime, Quantity, Range, Ratio, Annotation, Address, Duration, CodeableConcept

<a id="InventoryItem.instance"></a>

InventoryItem.instance

Instances or occurrences of the product

Definition: Instances or occurrences of the product.

Cardinality: 0..1

Type: BackboneElement

<a id="InventoryItem.instance.identifier"></a>

InventoryItem.instance.identifier

The identifier for the physical instance, typically a serial number

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

Cardinality: 0..*

Type: Identifier

<a id="InventoryItem.instance.lotNumber"></a>

InventoryItem.instance.lotNumber

The lot or batch number of the item

Definition: The lot or batch number of the item.

Cardinality: 0..1

Type: string

<a id="InventoryItem.instance.expiry"></a>

InventoryItem.instance.expiry

The expiry date or date and time for the product

Definition: The expiry date or date and time for the product.

Cardinality: 0..1

Type: dateTime

<a id="InventoryItem.instance.subject"></a>

InventoryItem.instance.subject

The subject that the item is associated with

Definition: The subject that the item is associated with.

Comments: Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

Cardinality: 0..1

Type: Reference(Patient, Organization, Group)

<a id="InventoryItem.instance.location"></a>

InventoryItem.instance.location

The location that the item is associated with

Definition: The location that the item is associated with.

Cardinality: 0..1

Type: Reference(Location)

<a id="InventoryItem.productReference"></a>

InventoryItem.productReference

Link to a product resource used in clinical workflows

Definition: Link to a product resource used in clinical workflows.

Cardinality: 0..1

Type: Reference(Medication, Device, NutritionProduct, BiologicallyDerivedProduct)