type: resourceresource: InventoryReport

InventoryReport

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.

InventoryReport [0..*]: - A report of inventory or stock items
InventoryReport.identifier [0..*]: Identifier Business identifier for the report
InventoryReport.status [1..1]: code required:inventoryreport-status draft | requested | active | entered-in-error
InventoryReport.countType [1..1]: code required:inventoryreport-counttype snapshot | difference
InventoryReport.operationType [0..1]: CodeableConcept addition | subtraction
InventoryReport.operationTypeReason [0..1]: CodeableConcept The reason for this count - regular count, ad-hoc count, new arrivals, etc
InventoryReport.reportedDateTime [1..1]: dateTime When the report has been submitted
InventoryReport.reporter [0..1]: [Reference(Practitioner](/Reference(Practitioner), Patient, RelatedPerson, Device)) Who submits the report
InventoryReport.reportingPeriod [0..1]: Period The period the report refers to
InventoryReport.inventoryListing [0..*]: BackboneElement An inventory listing section (grouped by any of the attributes)
InventoryReport.inventoryListing.location [0..1]: Reference(Location) Location of the inventory items
InventoryReport.inventoryListing.itemStatus [0..1]: CodeableConcept The status of the items that are being reported
InventoryReport.inventoryListing.countingDateTime [0..1]: dateTime The date and time when the items were counted
InventoryReport.inventoryListing.item [0..*]: BackboneElement The item or items in this listing
InventoryReport.inventoryListing.item.category [0..1]: CodeableConcept The inventory category or classification of the items being reported
InventoryReport.inventoryListing.item.quantity [1..1]: Quantity The quantity of the item or items being reported
InventoryReport.inventoryListing.item.item [1..1]: CodeableReference The code or reference to the item type
InventoryReport.note [0..*]: Annotation A note associated with the InventoryReport

Mappings

InventoryReport Mappings — 12 mapping entries

Resource Packs

list-InventoryReport-packs.xml

<?xml version="1.0" encoding="UTF-8"?>

<List xmlns="http://hl7.org/fhir">
  <id value="InventoryReport-packs"/>
  <status value="current"/>
  <mode value="working"/>
</List>

Search Parameters

identifier — token — Search by identifier — InventoryReport.identifier
status — token — Search by status — InventoryReport.status
item — token — Search by items in inventory report — InventoryReport.inventoryListing.item.item.concept
item-reference — reference — Search by items in inventory report — InventoryReport.inventoryListing.item.item.reference

Full Search Parameters

Examples

example — inventoryreport-example — Example of inventoryreport
inventoryreport-example — inventoryreport-example
inventoryreport-examples-header — inventoryreport-examples-header

Full Examples

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). 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