OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: InventoryReport

Official URL: http://hl7.org/fhir/StructureDefinition/InventoryReport Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-02 Maturity Level: 0 Computable Name: InventoryReport
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1068

A report of inventory or stock items.

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.

Usages:

  • This Resource is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryReport 0..* DomainResource A report of inventory or stock items

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier for the report
... status ?!Σ 1..1 code draft | requested | active | entered-in-error
Binding: Inventory Report Status (required): The status of the InventoryReport.
... countType ?!Σ 1..1 code snapshot | difference
Binding: Inventory Count Type (required): The type of count.
... operationTypeReason Σ 0..1 CodeableConcept The reason for this count - regular count, ad-hoc count, new arrivals, etc
... reportedDateTime Σ 1..1 dateTime When the report has been submitted
... reporter 0..1 Reference(Practitioner | Patient | RelatedPerson | Device) Who submits the report
... reportingPeriod 0..1 Period The period the report refers to
... inventoryListing Σ 0..* BackboneElement An inventory listing section (grouped by any of the attributes)
.... location 0..1 Reference(Location) Location of the inventory items
.... itemStatus Σ 0..1 CodeableConcept The status of the items that are being reported
.... countingDateTime 0..1 dateTime The date and time when the items were counted
.... item Σ 0..* BackboneElement The item or items in this listing
..... category Σ 0..1 CodeableConcept The inventory category or classification of the items being reported
..... quantity Σ 1..1 Quantity The quantity of the item or items being reported
..... item Σ 1..1 CodeableReference(Medication | Device | NutritionProduct | InventoryItem | BiologicallyDerivedProduct) The code or reference to the item type
... note 0..* Annotation A note associated with the InventoryReport

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InventoryReport.status Base required Inventory Report Status 📦0.1.0 This IG
InventoryReport.countType Base required Inventory Count Type 📦0.1.0 This IG 
<InventoryReport xmlns="http://hl7.org/fhir"> ​doco
 <id value="[id]"/><!-- 0..1 * Logical id of this artifact  -->
 <meta><!-- I 0..1 * Metadata about the resource  --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 * A set of rules under which this content was created  -->
 <language value="[code]"/><!-- I 0..1 * Language of the resource content  -->
 <text><!-- I 0..1 * Text summary of the resource, for human interpretation  --></text>
 <contained><!-- 0..* * Contained, inline Resources  --></contained>
 <extension><!-- See Extensions  Additional content defined by implementations  --></extension>
 <modifierExtension><!-- I 0..* * Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* * Business identifier for the report  --></identifier>
 <status value="[code]"/><!-- 1..1 * draft | requested | active | entered-in-error  -->
 <countType value="[code]"/><!-- 1..1 * snapshot | difference  -->
 <operationType><!-- 0..1 * addition | subtraction  --></operationType>
 <operationTypeReason><!-- 0..1 * The reason for this count - regular count, ad-hoc count, new arrivals, etc  --></operationTypeReason>
 <reportedDateTime value="[dateTime]"/><!-- 1..1 * When the report has been submitted  -->
 <reporter><!-- 0..1 * Who submits the report  --></reporter>
 <reportingPeriod><!-- 0..1 * The period the report refers to  --></reportingPeriod>
 <inventoryListing> I 0..* *  <!-- I 0..* An inventory listing section (grouped by any of the attributes) -->
  <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing   -->
  <extension><!-- See Extensions  Additional content defined by implementations   --></extension>
  <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <location><!-- 0..1 * Location of the inventory items   --></location>
  <itemStatus><!-- 0..1 * The status of the items that are being reported   --></itemStatus>
  <countingDateTime value="[dateTime]"/><!-- 0..1 * The date and time when the items were counted   -->
  <item> I 0..* *  <!-- I 0..* The item or items in this listing -->
   <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing    -->
   <extension><!-- See Extensions  Additional content defined by implementations    --></extension>
   <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized    --></modifierExtension>
   <category><!-- 0..1 * The inventory category or classification of the items being reported    --></category>
   <quantity><!-- 1..1 * The quantity of the item or items being reported    --></quantity>
   <item><!-- 1..1 * The code or reference to the item type    --></item>
  </item>
 </inventoryListing>
 <note><!-- 0..* * A note associated with the InventoryReport  --></note>
</InventoryReport>

{​doco
  "resourceType" : "InventoryReport",
  "id" : "<id>", // 0..1 Logical id of this artifact
  "meta" : { Meta }, // I 0..1 Metadata about the resource
  "implicitRules" : "<uri>", // I 0..1 A set of rules under which this content was created
  "language" : "<code>", // I 0..1 Language of the resource content
  "text" : { Narrative }, // I 0..1 Text summary of the resource, for human interpretation
  "contained" : [{ Resource }], // 0..* Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* Business identifier for the report
  "status" : "<code>", // 1..1 draft | requested | active | entered-in-error
  "countType" : "<code>", // 1..1 snapshot | difference
  "operationType" : { CodeableConcept }, // 0..1 addition | subtraction
  "operationTypeReason" : { CodeableConcept }, // 0..1 The reason for this count - regular count, ad-hoc count, new arrivals, etc
  "reportedDateTime" : "<dateTime>", // 1..1 When the report has been submitted
  "reporter" : { Reference(Device|Patient|Practitioner|RelatedPerson) }, // 0..1 Who submits the report
  "reportingPeriod" : { Period }, // 0..1 The period the report refers to
  "inventoryListing" : [{ BackboneElement }], // I 0..* An inventory listing section (grouped by any of the attributes)
    "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "location" : { Reference(Location) }, // 0..1 Location of the inventory items
    "itemStatus" : { CodeableConcept }, // 0..1 The status of the items that are being reported
    "countingDateTime" : "<dateTime>", // 0..1 The date and time when the items were counted
    "item" : [{ BackboneElement }] // I 0..* The item or items in this listing
      "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
      "category" : { CodeableConcept }, // 0..1 The inventory category or classification of the items being reported
      "quantity" : { Quantity }, // 1..1 The quantity of the item or items being reported
      "item" : { CodeableReference(BiologicallyDerivedProduct|Device|
     InventoryItem|Medication|NutritionProduct) } // 1..1 The code or reference to the item type
    }
  }
  "note" : [{ Annotation }] // 0..* A note associated with the InventoryReport
}

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:InventoryReport;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* I Extensions that cannot be ignored
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for the report
  fhir:status [ code ] ; # 1..1 draft | requested | active | entered-in-error
  fhir:countType [ code ] ; # 1..1 snapshot | difference
  fhir:operationType [ CodeableConcept ] ; # 0..1 addition | subtraction
  fhir:operationTypeReason [ CodeableConcept ] ; # 0..1 The reason for this count - regular count, ad-hoc count, new arrivals, etc
  fhir:reportedDateTime [ dateTime ] ; # 1..1 When the report has been submitted
  fhir:reporter [ Reference(Device|Patient|Practitioner|RelatedPerson) ] ; # 0..1 Who submits the report
  fhir:reportingPeriod [ Period ] ; # 0..1 The period the report refers to
  fhir:inventoryListing  ( [ BackboneElement ] ... ) ; # 0..* I An inventory listing section (grouped by any of the attributes)
  fhir:note  ( [ Annotation ] ... ) ; # 0..* A note associated with the InventoryReport
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. InventoryReport 0..* DomainResource A report of inventory or stock items

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier for the report
... status ?!Σ 1..1 code draft | requested | active | entered-in-error
Binding: Inventory Report Status (required): The status of the InventoryReport.
... countType ?!Σ 1..1 code snapshot | difference
Binding: Inventory Count Type (required): The type of count.
... operationTypeReason Σ 0..1 CodeableConcept The reason for this count - regular count, ad-hoc count, new arrivals, etc
... reportedDateTime Σ 1..1 dateTime When the report has been submitted
... reporter 0..1 Reference(Practitioner | Patient | RelatedPerson | Device) Who submits the report
... reportingPeriod 0..1 Period The period the report refers to
... inventoryListing Σ 0..* BackboneElement An inventory listing section (grouped by any of the attributes)
.... location 0..1 Reference(Location) Location of the inventory items
.... itemStatus Σ 0..1 CodeableConcept The status of the items that are being reported
.... countingDateTime 0..1 dateTime The date and time when the items were counted
.... item Σ 0..* BackboneElement The item or items in this listing
..... category Σ 0..1 CodeableConcept The inventory category or classification of the items being reported
..... quantity Σ 1..1 Quantity The quantity of the item or items being reported
..... item Σ 1..1 CodeableReference(Medication | Device | NutritionProduct | InventoryItem | BiologicallyDerivedProduct) The code or reference to the item type
... note 0..* Annotation A note associated with the InventoryReport

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
InventoryReport.status Base required Inventory Report Status 📦0.1.0 This IG
InventoryReport.countType Base required Inventory Count Type 📦0.1.0 This IG

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
identifier token

Search by identifier

 InventoryReport.identifier
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
status token

Search by status

 InventoryReport.status