BioMaxis Implementation Guide
0.0.0-semantic-release - ci-build

BioMaxis Implementation Guide - Local Development build (v0.0.0-semantic-release) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: InventoryItem

Official URL: http://biomaxis.com/fhir/StructureDefinition/InventoryItem Version: 0.0.0-semantic-release
Active as of 2025-12-12 Computable Name: InventoryItem

An InventoryItem represents a specific item in the inventory, including its stock levels and related information.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* DomainResource InventoryItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for the inventory item
... code 0..1 Coding Code designating the specific type of item
... name 1..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nameType 1..1 Coding The type of name
.... language 1..1 code The language used to express the item name
Binding: CommonLanguages (required)
.... name 1..1 string The name or designation of the item
... status 1..1 code active | inactive | entered-in-error | unknown
Binding: inventoryitem-status (??) (required)
... description 0..1 string Textual description of the item
... category 0..1 CodeableConcept Category or class of the item
... responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
... baseUnit 0..1 Coding 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
... lowStockQuantity 0..1 SimpleQuantity The low stock threshold for the item
... lot 0..* BackboneElement Occurrences of the item in stock
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code The code of the stock item
.... lotNumber 1..1 string The lot or batch number of the stock item
.... location 1..1 Reference(Location) The location where the stock item is stored
.... purchasePrice 0..1 Money The purchase price of the stock item
.... sellingPrice 0..1 Money The selling price of the stock item
.... expiryDate 0..1 date The expiry date for the product in stock
.... quantity 1..1 SimpleQuantity The quantity of the stock item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InventoryItem.name.language Base required Common Languages 📦4.0.1 FHIR Std.
InventoryItem.status Base required http://hl7.org/fhir/ValueSet/inventoryitem-status Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error InventoryItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InventoryItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InventoryItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* DomainResource InventoryItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier for the inventory item
... code 0..1 Coding Code designating the specific type of item
... name 1..* 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
.... language 1..1 code The language used to express the item name
Binding: CommonLanguages (required)
.... name 1..1 string The name or designation of the item
... description 0..1 string Textual description of the item
... category 0..1 CodeableConcept Category or class 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
... baseUnit 0..1 Coding 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
... lowStockQuantity 0..1 SimpleQuantity The low stock threshold for the item
... lot 0..* BackboneElement Occurrences of the item in stock
.... code 1..1 code The code of the stock item
.... lotNumber 1..1 string The lot or batch number of the stock item
.... location 1..1 Reference(Location) The location where the stock item is stored
.... purchasePrice 0..1 Money The purchase price of the stock item
.... sellingPrice 0..1 Money The selling price of the stock item
.... expiryDate 0..1 date The expiry date for the product in stock
.... quantity 1..1 SimpleQuantity The quantity of the stock item

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InventoryItem.name.language Base required Common Languages 📦4.0.1 FHIR Std.
InventoryItem.status Base required http://hl7.org/fhir/ValueSet/inventoryitem-status Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* DomainResource InventoryItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for the inventory item
... code 0..1 Coding Code designating the specific type of item
... name 1..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nameType 1..1 Coding The type of name
.... language 1..1 code The language used to express the item name
Binding: CommonLanguages (required)
.... name 1..1 string The name or designation of the item
... status 1..1 code active | inactive | entered-in-error | unknown
Binding: inventoryitem-status (??) (required)
... description 0..1 string Textual description of the item
... category 0..1 CodeableConcept Category or class of the item
... responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
... baseUnit 0..1 Coding 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
... lowStockQuantity 0..1 SimpleQuantity The low stock threshold for the item
... lot 0..* BackboneElement Occurrences of the item in stock
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code The code of the stock item
.... lotNumber 1..1 string The lot or batch number of the stock item
.... location 1..1 Reference(Location) The location where the stock item is stored
.... purchasePrice 0..1 Money The purchase price of the stock item
.... sellingPrice 0..1 Money The selling price of the stock item
.... expiryDate 0..1 date The expiry date for the product in stock
.... quantity 1..1 SimpleQuantity The quantity of the stock item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InventoryItem.name.language Base required Common Languages 📦4.0.1 FHIR Std.
InventoryItem.status Base required http://hl7.org/fhir/ValueSet/inventoryitem-status Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error InventoryItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InventoryItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InventoryItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(11 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* DomainResource InventoryItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for the inventory item
... code 0..1 Coding Code designating the specific type of item
... name 1..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nameType 1..1 Coding The type of name
.... language 1..1 code The language used to express the item name
Binding: CommonLanguages (required)
.... name 1..1 string The name or designation of the item
... status 1..1 code active | inactive | entered-in-error | unknown
Binding: inventoryitem-status (??) (required)
... description 0..1 string Textual description of the item
... category 0..1 CodeableConcept Category or class of the item
... responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
... baseUnit 0..1 Coding 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
... lowStockQuantity 0..1 SimpleQuantity The low stock threshold for the item
... lot 0..* BackboneElement Occurrences of the item in stock
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code The code of the stock item
.... lotNumber 1..1 string The lot or batch number of the stock item
.... location 1..1 Reference(Location) The location where the stock item is stored
.... purchasePrice 0..1 Money The purchase price of the stock item
.... sellingPrice 0..1 Money The selling price of the stock item
.... expiryDate 0..1 date The expiry date for the product in stock
.... quantity 1..1 SimpleQuantity The quantity of the stock item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InventoryItem.name.language Base required Common Languages 📦4.0.1 FHIR Std.
InventoryItem.status Base required http://hl7.org/fhir/ValueSet/inventoryitem-status Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error InventoryItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InventoryItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InventoryItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* DomainResource InventoryItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier for the inventory item
... code 0..1 Coding Code designating the specific type of item
... name 1..* 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
.... language 1..1 code The language used to express the item name
Binding: CommonLanguages (required)
.... name 1..1 string The name or designation of the item
... description 0..1 string Textual description of the item
... category 0..1 CodeableConcept Category or class 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
... baseUnit 0..1 Coding 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
... lowStockQuantity 0..1 SimpleQuantity The low stock threshold for the item
... lot 0..* BackboneElement Occurrences of the item in stock
.... code 1..1 code The code of the stock item
.... lotNumber 1..1 string The lot or batch number of the stock item
.... location 1..1 Reference(Location) The location where the stock item is stored
.... purchasePrice 0..1 Money The purchase price of the stock item
.... sellingPrice 0..1 Money The selling price of the stock item
.... expiryDate 0..1 date The expiry date for the product in stock
.... quantity 1..1 SimpleQuantity The quantity of the stock item

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InventoryItem.name.language Base required Common Languages 📦4.0.1 FHIR Std.
InventoryItem.status Base required http://hl7.org/fhir/ValueSet/inventoryitem-status Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* DomainResource InventoryItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for the inventory item
... code 0..1 Coding Code designating the specific type of item
... name 1..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nameType 1..1 Coding The type of name
.... language 1..1 code The language used to express the item name
Binding: CommonLanguages (required)
.... name 1..1 string The name or designation of the item
... status 1..1 code active | inactive | entered-in-error | unknown
Binding: inventoryitem-status (??) (required)
... description 0..1 string Textual description of the item
... category 0..1 CodeableConcept Category or class of the item
... responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
... baseUnit 0..1 Coding 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
... lowStockQuantity 0..1 SimpleQuantity The low stock threshold for the item
... lot 0..* BackboneElement Occurrences of the item in stock
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code The code of the stock item
.... lotNumber 1..1 string The lot or batch number of the stock item
.... location 1..1 Reference(Location) The location where the stock item is stored
.... purchasePrice 0..1 Money The purchase price of the stock item
.... sellingPrice 0..1 Money The selling price of the stock item
.... expiryDate 0..1 date The expiry date for the product in stock
.... quantity 1..1 SimpleQuantity The quantity of the stock item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
InventoryItem.name.language Base required Common Languages 📦4.0.1 FHIR Std.
InventoryItem.status Base required http://hl7.org/fhir/ValueSet/inventoryitem-status Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error InventoryItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error InventoryItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error InventoryItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice InventoryItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(11 nested mandatory elements)

Structures

This structure refers to these other structures:

 

​Other representations of profile: CSV, Excel, Schematron