0.0.1 - 0.0.1

EAHPInteroperabilityIG - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: InventoryItem EAHP Interoperability

Official URL: https://eahp-official.github.io/EAHP_Interoperabillty/StructureDefinition/InventoryItemEAHPInteroperability Version: 0.0.1
Draft as of 2026-05-13 Computable Name: InventoryItemEAHPInteroperability

Defines the specific logistical unit managed within EAHP interoperability workflows. This resource represents the physical base stock unit as recognized by automated inventory systems. The granularity of this unit is determined by the automation context: it may represent a pack (whether complete or partial) for box-handling robots, a single unit dose for dispensing robots, or a compounding container (such as an IV bag) for compounding robots. Product details (such as name) are derived from the referenced product, while this resource tracks the instance-specific status, location, and expiry.

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..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... inventoryStatus SΣ 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit SΣ 1..1 CodeableConcept Atomic Logistical Unit
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: indivisible-logistical-unit
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... netContent SΣ 1..1 EAHPLogisticalQuantity Net content or amount present in the item
... instance 1..1 BackboneElement Instances or occurrences of the product
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
Slice: Unordered, Open by pattern:type
..... identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC)
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: FMD_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:serialNumber S 0..1 Identifier Parsed Serial Number
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: SNO
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags)
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.)
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PC
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:productBarcode S 0..1 Identifier Product barcode
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRODUCT_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
.... lotNumber S 0..1 string The lot or batch number of the item
.... expiry S 0..1 dateTime The expiry date or date and time for the product
.... location S 0..1 Reference(Location) The location that the item is associated with
... productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.status Base required InventoryItem Status Codes 📍5.0.0 FHIR Std.
InventoryItem.name.nameType Base preferred InventoryItem Name Typess 📍5.0.0 FHIR Std.
InventoryItem.name.language Base required Common Languages 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 InventoryItem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... name 0..0 Name is removed to enforce usage of productReference
... inventoryStatus S 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit S 1..1 CodeableConcept Atomic Logistical Unit
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: indivisible-logistical-unit
... instance 1..1 BackboneElement Instances or occurrences of the product
.... Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
Slice: Unordered, Open by pattern:type
..... identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC)
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: FMD_BARCODE
..... identifier:serialNumber S 0..1 Identifier Parsed Serial Number
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: SNO
..... identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags)
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
..... identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.)
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PC
..... identifier:productBarcode S 0..1 Identifier Product barcode
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRODUCT_BARCODE
.... lotNumber S 0..1 string The lot or batch number of the item
.... expiry S 0..1 dateTime The expiry date or date and time for the product
.... location S 0..1 Reference(Location) The location that the item is associated with
... productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... 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
... code Σ 0..* CodeableConcept Code designating the specific type of item
... responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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
... description 0..1 BackboneElement Descriptive characteristics of the item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 SΣ 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit SΣ 1..1 CodeableConcept Atomic Logistical Unit
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: indivisible-logistical-unit
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... netContent SΣ 1..1 EAHPLogisticalQuantity Net content or amount present in the item
... association 0..* BackboneElement Association with other items or products
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 1..1 BackboneElement Instances or occurrences of the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
Slice: Unordered, Open by pattern:type
..... identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: FMD_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:serialNumber S 0..1 Identifier Parsed Serial Number
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: SNO
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PC
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:productBarcode S 0..1 Identifier Product barcode
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRODUCT_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... lotNumber S 0..1 string The lot or batch number of the item
.... expiry S 0..1 dateTime The expiry date or date and time for the product
.... subject 0..1 Reference(Patient | Organization) The subject that the item is associated with
.... location S 0..1 Reference(Location) The location that the item is associated with
... productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.language Base required All Languages 📍5.0.0 FHIR Std.
InventoryItem.status Base required InventoryItem Status Codes 📍5.0.0 FHIR Std.
InventoryItem.name.nameType Base preferred InventoryItem Name Typess 📍5.0.0 FHIR Std.
InventoryItem.name.language Base required Common Languages 📍5.0.0 FHIR Std.
InventoryItem.description.​language Base required Common Languages 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 InventoryItem

Summary

Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of InventoryItem.instance.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... inventoryStatus SΣ 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit SΣ 1..1 CodeableConcept Atomic Logistical Unit
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: indivisible-logistical-unit
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... netContent SΣ 1..1 EAHPLogisticalQuantity Net content or amount present in the item
... instance 1..1 BackboneElement Instances or occurrences of the product
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
Slice: Unordered, Open by pattern:type
..... identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC)
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: FMD_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:serialNumber S 0..1 Identifier Parsed Serial Number
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: SNO
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags)
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.)
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PC
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
..... identifier:productBarcode S 0..1 Identifier Product barcode
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRODUCT_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
.... lotNumber S 0..1 string The lot or batch number of the item
.... expiry S 0..1 dateTime The expiry date or date and time for the product
.... location S 0..1 Reference(Location) The location that the item is associated with
... productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.status Base required InventoryItem Status Codes 📍5.0.0 FHIR Std.
InventoryItem.name.nameType Base preferred InventoryItem Name Typess 📍5.0.0 FHIR Std.
InventoryItem.name.language Base required Common Languages 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 InventoryItem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... name 0..0 Name is removed to enforce usage of productReference
... inventoryStatus S 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit S 1..1 CodeableConcept Atomic Logistical Unit
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: indivisible-logistical-unit
... instance 1..1 BackboneElement Instances or occurrences of the product
.... Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
Slice: Unordered, Open by pattern:type
..... identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC)
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: FMD_BARCODE
..... identifier:serialNumber S 0..1 Identifier Parsed Serial Number
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: SNO
..... identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags)
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
..... identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.)
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PC
..... identifier:productBarcode S 0..1 Identifier Product barcode
...... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRODUCT_BARCODE
.... lotNumber S 0..1 string The lot or batch number of the item
.... expiry S 0..1 dateTime The expiry date or date and time for the product
.... location S 0..1 Reference(Location) The location that the item is associated with
... productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... 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
... code Σ 0..* CodeableConcept Code designating the specific type of item
... responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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
... description 0..1 BackboneElement Descriptive characteristics of the item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 SΣ 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit SΣ 1..1 CodeableConcept Atomic Logistical Unit
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: indivisible-logistical-unit
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... netContent SΣ 1..1 EAHPLogisticalQuantity Net content or amount present in the item
... association 0..* BackboneElement Association with other items or products
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 1..1 BackboneElement Instances or occurrences of the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
Slice: Unordered, Open by pattern:type
..... identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: FMD_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:serialNumber S 0..1 Identifier Parsed Serial Number
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: SNO
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PC
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... identifier:productBarcode S 0..1 Identifier Product barcode
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRODUCT_BARCODE
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣC 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... lotNumber S 0..1 string The lot or batch number of the item
.... expiry S 0..1 dateTime The expiry date or date and time for the product
.... subject 0..1 Reference(Patient | Organization) The subject that the item is associated with
.... location S 0..1 Reference(Location) The location that the item is associated with
... productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
InventoryItem.language Base required All Languages 📍5.0.0 FHIR Std.
InventoryItem.status Base required InventoryItem Status Codes 📍5.0.0 FHIR Std.
InventoryItem.name.nameType Base preferred InventoryItem Name Typess 📍5.0.0 FHIR Std.
InventoryItem.name.language Base required Common Languages 📍5.0.0 FHIR Std.
InventoryItem.description.​language Base required Common Languages 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:rawScan.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:serialNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:vendorAssigned.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productCode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
InventoryItem.instance.​identifier:productBarcode.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 InventoryItem

Summary

Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of InventoryItem.instance.identifier

 

Other representations of profile: CSV, Excel, Schematron