Generated Narrative: StructureDefinition InventoryItem Name Flags Card. Type Description & Constraints InventoryItem 0..* DomainResource A functional description of an inventory item used in inventory and supply-related workflows Elements defined in Ancestors:id, meta, <a href="http://hl7.org/fhir/6.0.0-ballot5/resource.html" title="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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.">implicitRules, language, <a href="http://hl7.org/fhir/6.0.0-ballot5/domainresource.html" title="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.">text, contained, <a href="http://hl7.org/fhir/6.0.0-ballot5/domainresource.html" title="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.">extension, <a href="http://hl7.org/fhir/6.0.0-ballot5/domainresource.html" title="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.#xA;#xA;Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).">modifierExtension #xD; identifier Σ 0..* Identifier Business identifier for the inventory item #xD; status Σ 1..1 code active | inactive | entered-in-error | unknown Binding: InventoryItem Status Codes Values (required): Status of the inventory item. #xD; category Σ 0..* CodeableConcept Category or class of the item #xD; classification Σ 0..* BackboneElement What kind of inventory item this is #xD; type Σ 1..1 CodeableConcept A classification of the inventory item #xD; justification 0..* RelatedArtifact Further information qualifying this classification of the inventoryItem #xD; code Σ 0..* CodeableConcept Code designating the specific type of item #xD; name Σ 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others #xD; nameType Σ 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItem Name Types Values (preferred): Name types. #xD; language Σ 1..1 code The language used to express the item name Binding: AllLanguages (preferred): Name languages. #xD; name Σ 1..1 string The name or designation of the item #xD; responsibleOrganization 0..* BackboneElement Organization(s) responsible for the product #xD; role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other #xD; organization 1..1 Reference(Organization) An organization that is associated with the item #xD; description 0..1 BackboneElement Descriptive characteristics of the item #xD; language 0..1 code The language that is used in the item description Binding: AllLanguages (preferred): Description languages. #xD; description 0..1 string Textual description of the item #xD; inventoryStatus Σ 0..* CodeableConcept The usage status like recalled, in use, discarded #xD; baseUnit Σ 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted #xD; netContent Σ 0..1 SimpleQuantity Net content or amount present in the item #xD; association 0..* BackboneElement Association with other items or products #xD; associationType Σ 1..1 CodeableConcept The type of association between the device and the other item #xD; relatedItem Σ 1..1 Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product #xD; <a href="StructureDefinition-InventoryItem-definitions.html#InventoryItem.association.quantity" title="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.">quantity Σ 1..1 Ratio The quantity of the product in this product #xD; characteristic 0..* BackboneElement Characteristic of the item #xD; characteristicType 1..1 CodeableConcept The characteristic that is being defined #xD; value[x] 1..1 The value of the attribute #xD; valueString string #xD; valueInteger integer #xD; valueDecimal decimal #xD; valueBoolean boolean #xD; valueUrl url #xD; valueDateTime dateTime #xD; valueQuantity Quantity #xD; valueRange Range #xD; valueRatio Ratio #xD; valueAnnotation Annotation #xD; <span title="Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.#xA;The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.">valueAddress Address #xD; valueDuration Duration #xD; valueCodeableConcept CodeableConcept #xD; instance 0..1 BackboneElement Instances or occurrences of the product #xD; identifier 0..* Identifier The identifier for the physical instance, typically a serial number #xD; lotNumber 0..1 string The lot or batch number of the item #xD; expiry 0..1 dateTime The expiry date or date and time for the product #xD; subject 0..1 Reference(Patient | Organization | Group) The subject that the item is associated with #xD; location 0..1 Reference(Location) The location that the item is associated with #xD; productReference 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows #xD; Documentation for this format
HL7 International / Orders and Observations
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
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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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
Entity. Role, or Act,Entity, Role, or Act
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 resource 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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.
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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
Extensions are always sliced by (at least) url
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.
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://build.fhir.org/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
A coded concept specifying the status of the inventory item.
In this element various classifications can be used.
All FHIR elements must have a @value or children or both
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
A classification or nomenclature for the inventory item.
In this element various classification systems may be used.
Further information qualifying this classification of the inventoryItem
Additional information supporting the classification of the inventoryItem.
Code designating the specific type of item
Code designating the specific type of item.
The item name(s) - the brand name, or common name, functional name, generic name or others
The item name(s) - the brand name, or common name, functional name, generic name.
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 languages for a description of an item
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.
The base unit of measure - the unit in which the product is used or counted
The base unit of measure - the unit in which the product is used or counted.
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.
The identifier for the physical instance, typically a serial number
The identifier for the physical instance, typically a serial number.
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.
Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.
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.