Generated Narrative: StructureDefinition InventoryItemEAHPInteroperability Name Flags Card. Type Description & Constraints InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows #xD; name 0..0 Name is removed to enforce usage of productReference #xD; inventoryStatus S 0..* CodeableConcept The usage status like recalled, in use, discarded #xD; <a href="StructureDefinition-InventoryItemEAHPInteroperability-definitions.html#InventoryItem.baseUnit" title="Mandatory. Defines the granularity of this item as the smallest, indivisible unit handled by the automation system. This abstracts away the physical form (tablet, vial, etc.) and focuses purely on the logistical count of '1'. An Atomic Logistical unit can physically be a tablet, a vial, a syrup bottle, a cream tube etc., but NOT a milligram, spoon, pack, or box.">baseUnit S 1..1 CodeableConcept Atomic Logistical Unit Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-logistics-unit-cs #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: indivisible-logistical-unit #xD; netContent S 1..1 EAHPLogisticalQuantity Net content or amount present in the item #xD; instance 1..1 BackboneElement Instances or occurrences of the product #xD; Slices for identifier S 0..* Identifier List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID) Slice: Unordered, Open by pattern:type #xD; identifier:rawScan S 0..1 Identifier Raw 2D Barcode Data (e.g. GS1, IFA ASC) #xD; type 1..1 CodeableConcept Description of identifier Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: FMD_BARCODE #xD; identifier:serialNumber S 0..1 Identifier Parsed Serial Number #xD; type 1..1 CodeableConcept Description of identifier Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: SNO #xD; <a href="StructureDefinition-InventoryItemEAHPInteroperability-definitions.html#InventoryItem.instance.identifier:vendorAssigned" title="Slice vendorAssigned: A locally unique identifier assigned by the automation system to a specific unit dose or compounded preparation. This ID is generated by the robot (e.g., a pick-id or waffle-id) and is unique only within the namespace of that specific machine or hospital system.">identifier:vendorAssigned S 0..1 Identifier Robot-generated Unique ID (for Unit Doses/Bags) #xD; type 1..1 CodeableConcept Description of identifier Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: RI #xD; identifier:productCode S 0..1 Identifier Parsed Product Code (GTIN, PZN, etc.) #xD; type 1..1 CodeableConcept Description of identifier Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: PC #xD; identifier:productBarcode S 0..1 Identifier Product barcode #xD; type 1..1 CodeableConcept Description of identifier Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: https://eahp-official.github.io/EAHP_Interoperabillty/CodeSystem/eahp-identifier-type-cs #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: PRODUCT_BARCODE #xD; lotNumber S 0..1 string The lot or batch number of the item #xD; expiry S 0..1 dateTime The expiry date or date and time for the product #xD; location S 0..1 Reference(Location) The location that the item is associated with #xD; productReference S 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows #xD; Documentation for this format
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.
A functional description of an inventory item used in inventory and supply-related workflows
A functional description of an inventory item used in inventory and supply-related workflows.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
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()
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()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Business identifier for the inventory item
Business identifier for the inventory item.
active | inactive | entered-in-error | unknown
Code designating the specific type of item
Code designating the specific type of item.
Name is removed to enforce usage of productReference
The name is strictly forbidden to prevent data duplication. The display name must be retrieved from the resolved productReference.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The type of name e.g. 'brand-name', 'functional-name', 'common-name'
The type of name e.g. 'brand-name', 'functional-name', 'common-name'.
The language used to express the item name
The language that the item name is expressed in.
The name or designation that the item is given.
Organization(s) responsible for the product
Organization(s) responsible for the product.
The role of the organization e.g. manufacturer, distributor, or other
The role of the organization e.g. manufacturer, distributor, etc.
An organization that is associated with the item
An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etc.
The descriptive characteristics of the inventory item.
The language that is used in the item description
The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language.
The usage status like recalled, in use, discarded
The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etc.
Mandatory. Defines the granularity of this item as the smallest, indivisible unit handled by the automation system. This abstracts away the physical form (tablet, vial, etc.) and focuses purely on the logistical count of '1'. An Atomic Logistical unit can physically be a tablet, a vial, a syrup bottle, a cream tube etc., but NOT a milligram, spoon, pack, or box.
Net content or amount present in the item
Net content or amount present in the item.
Association with other items or products
Association with other items or products.
The type of association between the device and the other item
This attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed with.
The quantity of the product in this product
The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present product.
The descriptive or identifying characteristics of the item.
The characteristic that is being defined
The type of characteristic that is being defined.
The string value is used for characteristics that are descriptive and not codeable information. CodeableConcept.text is used when the characteristic is discrete and could otherwise be coded but for which there is no code available.
Instances or occurrences of the product.
List of identifiers (Raw Scan, Serial, Product Barcode or Vendor ID)
The identifier for the physical instance, typically a serial number.
The unparsed, full string read from a commercial pack barcode. Globally unique.
Extensions are always sliced by (at least) url
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
The distinct serial number component extracted from the package identifier. Note: This string is NOT globally unique on its own. It must be scoped by the Product BarCode to be unique.
Robot-generated Unique ID (for Unit Doses/Bags)
A locally unique identifier assigned by the automation system to a specific unit dose or compounded preparation. This ID is generated by the robot (e.g., a pick-id or waffle-id) and is unique only within the namespace of that specific machine or hospital system.
The parsed product-code component identifying the product, such as the GTIN AI (01) value from a GS1 DataMatrix, PZN, NRN, or equivalent product identifier.
The complete commercial product barcode value as scanned or exchanged when it is distinct from the parsed product-code component. For a full GS1 DataMatrix payload, use FMD_BARCODE.
The expiry date or date and time for the product
The expiry date or date and time for the product.
The subject that the item is associated with
The subject that the item is associated with.
The location that the item is associated with
The location that the item is associated with.
Link to a product resource used in clinical workflows
Link to a product resource used in clinical workflows.