--- type: "resource" title: "InventoryReport" resource: "InventoryReport" --- # InventoryReport ## Introduction ## Scope and Usage Lists the current status or changes to an inventory. The current status of inventory is presented as the quantity of items, grouped in listings, where a listing can be the items in a location, or with a given status. This is a 'snapshot' of the current inventory. The changes to an inventory are represented as the additions (incoming) or substractions (consumptions or outgoing) of items to an inventory listing. This is often used when there is a need to determine the increment/decrement in stock, and there is a need to only transmit the difference, without the need to update the entire snapshot. The inventory status can be available as a response to a request, or can be done ad-hoc (e.g. report a consumption for consignment stock) or scheduled (e.g. recount the stock every 6 months). ## Boundaries and Relationships The InventoryReport resource is associated with consumable items - typically resources like Medication, Devices. Inventory management is related to SupplyRequest and SupplyDelivery, which may be associated with an increase or decrease of inventory. xxDispense: The InventoryReport resource can also be used to indicate consumption of an item. When a Dispense event occurs, there is a depletion in stock. InventoryReport does not overlap with Dispense: Dispense carries the 'clinical' meaning that a product has been assigned to a patient. The InventoryReport captures the logistic aspect. For example (see examples) - when a Medication is dispensed to a patient, the use of an inventoryReport is not needed - when a Medication is dropped and afterwards disposed of, and therefore not used by any patient, the InventoryReport can captures this and inform the inventory management system about the subtraction of that item. - when there is a need to inform, for inventory reasons, the items that have been taken from stock, this can be done with an InventoryReport. ## Background and Context Provides additional detail on exactly how the resource is to be used ## StructureDefinition ### Elements (Simplified) - **[InventoryReport](/inventoryreport-definitions#InventoryReport)** [0..*]: - A report of inventory or stock items - **[InventoryReport.identifier](/inventoryreport-definitions#InventoryReport.identifier)** [0..*]: [Identifier](/Identifier) Business identifier for the report - **[InventoryReport.status](/inventoryreport-definitions#InventoryReport.status)** [1..1]: [code](/code) required:[inventoryreport-status](/valueset-inventoryreport-status) draft | requested | active | entered-in-error - **[InventoryReport.countType](/inventoryreport-definitions#InventoryReport.countType)** [1..1]: [code](/code) required:[inventoryreport-counttype](/valueset-inventoryreport-counttype) snapshot | difference - **[InventoryReport.operationType](/inventoryreport-definitions#InventoryReport.operationType)** [0..1]: [CodeableConcept](/CodeableConcept) addition | subtraction - **[InventoryReport.operationTypeReason](/inventoryreport-definitions#InventoryReport.operationTypeReason)** [0..1]: [CodeableConcept](/CodeableConcept) The reason for this count - regular count, ad-hoc count, new arrivals, etc - **[InventoryReport.reportedDateTime](/inventoryreport-definitions#InventoryReport.reportedDateTime)** [1..1]: [dateTime](/dateTime) When the report has been submitted - **[InventoryReport.reporter](/inventoryreport-definitions#InventoryReport.reporter)** [0..1]: [Reference(Practitioner](/Reference(Practitioner), [Patient](/Patient), [RelatedPerson](/RelatedPerson), [Device)](/Device)) Who submits the report - **[InventoryReport.reportingPeriod](/inventoryreport-definitions#InventoryReport.reportingPeriod)** [0..1]: [Period](/Period) The period the report refers to - **[InventoryReport.inventoryListing](/inventoryreport-definitions#InventoryReport.inventoryListing)** [0..*]: [BackboneElement](/BackboneElement) An inventory listing section (grouped by any of the attributes) - **[InventoryReport.inventoryListing.location](/inventoryreport-definitions#InventoryReport.inventoryListing.location)** [0..1]: Reference([Location](/Location)) Location of the inventory items - **[InventoryReport.inventoryListing.itemStatus](/inventoryreport-definitions#InventoryReport.inventoryListing.itemStatus)** [0..1]: [CodeableConcept](/CodeableConcept) The status of the items that are being reported - **[InventoryReport.inventoryListing.countingDateTime](/inventoryreport-definitions#InventoryReport.inventoryListing.countingDateTime)** [0..1]: [dateTime](/dateTime) The date and time when the items were counted - **[InventoryReport.inventoryListing.item](/inventoryreport-definitions#InventoryReport.inventoryListing.item)** [0..*]: [BackboneElement](/BackboneElement) The item or items in this listing - **[InventoryReport.inventoryListing.item.category](/inventoryreport-definitions#InventoryReport.inventoryListing.item.category)** [0..1]: [CodeableConcept](/CodeableConcept) The inventory category or classification of the items being reported - **[InventoryReport.inventoryListing.item.quantity](/inventoryreport-definitions#InventoryReport.inventoryListing.item.quantity)** [1..1]: [Quantity](/Quantity) The quantity of the item or items being reported - **[InventoryReport.inventoryListing.item.item](/inventoryreport-definitions#InventoryReport.inventoryListing.item.item)** [1..1]: [CodeableReference](/CodeableReference) The code or reference to the item type - **[InventoryReport.note](/inventoryreport-definitions#InventoryReport.note)** [0..*]: [Annotation](/Annotation) A note associated with the InventoryReport ## Mappings - [InventoryReport Mappings](/inventoryreport-mappings) — 12 mapping entries ## Resource Packs ### list-InventoryReport-packs.xml ```xml ``` ## Search Parameters - [identifier](/inventoryreport-search#identifier) — **token** — Search by identifier — `InventoryReport.identifier` - [status](/inventoryreport-search#status) — **token** — Search by status — `InventoryReport.status` - [item](/inventoryreport-search#item) — **token** — Search by items in inventory report — `InventoryReport.inventoryListing.item.item.concept` - [item-reference](/inventoryreport-search#item-reference) — **reference** — Search by items in inventory report — `InventoryReport.inventoryListing.item.item.reference` [Full Search Parameters](/inventoryreport-search) ## Examples - [example](/inventoryreport-example-example) — inventoryreport-example — Example of inventoryreport - [inventoryreport-example](/inventoryreport-example-inventoryreport-example) — inventoryreport-example - [inventoryreport-examples-header](/inventoryreport-example-inventoryreport-examples-header) — inventoryreport-examples-header [Full Examples](/inventoryreport-examples) ## Mapping Exceptions ### inventoryreport-event-mapping-exceptions.xml ### Divergent Elements - **Event.identifier** → **InventoryReport.identifier** - shortUnmatched | reason=Unknown | pattern=Business identifier for inventory report | resource=Business identifier for the report - definitionUnmatched | reason=Unknown | pattern=Business identifiers assigned to this inventory report by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | resource=Business identifier for the InventoryReport. - commentsUnmatched | reason=Unknown | pattern=Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. - requirementsUnmatched | reason=Unknown | pattern=Allows identification of the inventory report as it is known by various participating systems and in a way that remains consistent across servers. - **Event.status** → **InventoryReport.status** - shortUnmatched | reason=Unknown | pattern=preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown | resource=draft | requested | active | entered-in-error - definitionUnmatched | reason=Unknown | pattern=The current state of the inventory report. | resource=The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active. - commentsUnmatched | reason=Unknown | pattern=A nominal state-transition diagram can be found in the (Event pattern documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. ### Unmapped Elements - **Event.partOf** — Unknown - **Event.reported** — Unknown - **Event.reason** — Unknown - **Event.relevantHistory** — Unknown - **Event.code** — Unknown - **Event.location** — Unknown - **Event.subject** — Unknown - **Event.statusReason** — Unknown - **Event.performer.actor** — Unknown - **Event.performer.function** — Unknown - **Event.note** — Unknown - **Event.category** — Unknown - **Event.encounter** — Unknown - **Event.recorded** — Unknown - **Event.occurrence** — Unknown - **Event.product** — Unknown - **Event.performer** — Unknown - **Event.researchStudy** — Unknown ### inventoryreport-fivews-mapping-exceptions.xml ### Unmapped Elements - **FiveWs.what** — Unknown - **FiveWs.recorded** — Unknown - **FiveWs.author** — Unknown - **FiveWs.actor** — Unknown - **FiveWs.cause** — Unknown - **FiveWs.version** — Unknown - **FiveWs.witness** — Unknown - **FiveWs.class** — Unknown - **FiveWs.where** — Unknown - **FiveWs.context** — Unknown - **FiveWs.init** — Unknown - **FiveWs.why** — Unknown - **FiveWs.source** — Unknown - **FiveWs.who** — Unknown - **FiveWs.grade** — Unknown - **FiveWs.planned** — Unknown - **FiveWs.done** — Unknown - **FiveWs.subject** — Unknown