Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.29 Resource InventoryReport - Content

Orders and Observations icon

Work Group

Maturity Level: 0

Trial Use

Security Category: Business

Compartments: Not linked to any defined compartments

A report of inventory or stock items.

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

12.29.2 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 a 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.

12.29.3 References to this Resource

Implements: Event

Structure

Name	Flags	Card.	Type	Description & Constraints
InventoryReport	TU		DomainResource	A report of inventory or stock items Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Identifiers for the report
status	?!Σ	1..1	code	draft \| requested \| active \| entered-in-error InventoryReportStatus (Required)
countType	?!Σ	1..1	code	snapshot \| difference InventoryCountType (Required)
operationType	Σ	0..1	CodeableConcept	addition \| subtraction
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
countingDateTime		0..1	dateTime	The date and time when the items were counted
items	Σ	0..*	BackboneElement	The item or items in this listing
category	Σ	0..1	CodeableConcept	The category of the item or items
quantity	Σ	1..1	Quantity	The quantity of the item or items
item	Σ	1..1	CodeableReference(Device \| Medication)	The code or reference to the item type
lot		0..1	string	The lot number of the item or items
serial		0..1	string	The serial number of the item
expiry		0..1	dateTime	The expiry date of the item or items
manufacturingDate		0..1	dateTime	The manufacturingDate of the item or items
note		0..1	Annotation	A note associated with the InventoryReport
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<InventoryReport xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifiers 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 CodeableConcept addition | subtraction --></operationType>
 <operationTypeReason><!-- 0..1 CodeableConcept 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 Reference(Device|Patient|Practitioner|RelatedPerson) Who submits the report --></reporter>
 <reportingPeriod><!-- 0..1 Period The period the report refers to --></reportingPeriod>
 <inventoryListing>  <!-- 0..* An inventory listing section (grouped by any of the attributes) -->
  <location><!-- 0..1 Reference(Location) Location of the inventory items --></location>
  <itemStatus><!-- 0..1 CodeableConcept The status of the items --></itemStatus>
  <countingDateTime value="[dateTime]"/><!-- 0..1 The date and time when the items were counted -->
  <items>  <!-- 0..* The item or items in this listing -->
   <category><!-- 0..1 CodeableConcept The category of the item or items --></category>
   <quantity><!-- 1..1 Quantity The quantity of the item or items --></quantity>
   <item><!-- 1..1 CodeableReference(Device|Medication) The code or reference to the item type --></item>
   <lot value="[string]"/><!-- 0..1 The lot number of the item or items -->
   <serial value="[string]"/><!-- 0..1 The serial number of the item -->
   <expiry value="[dateTime]"/><!-- 0..1 The expiry date of the item or items -->
   <manufacturingDate value="[dateTime]"/><!-- 0..1 The manufacturingDate of the item or items -->
  </items>
 </inventoryListing>
 <note><!-- 0..1 Annotation A note associated with the InventoryReport --></note>
</InventoryReport>

JSON Template

{
  "resourceType" : "InventoryReport",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers for the report
  "status" : "<code>", // R!  draft | requested | active | entered-in-error
  "countType" : "<code>", // R!  snapshot | difference
  "operationType" : { CodeableConcept }, // addition | subtraction
  "operationTypeReason" : { CodeableConcept }, // The reason for this count - regular count, ad-hoc count, new arrivals, etc.
  "reportedDateTime" : "<dateTime>", // R!  When the report has been submitted
  "reporter" : { Reference(Device|Patient|Practitioner|RelatedPerson) }, // Who submits the report
  "reportingPeriod" : { Period }, // The period the report refers to
  "inventoryListing" : [{ // An inventory listing section (grouped by any of the attributes)
    "location" : { Reference(Location) }, // Location of the inventory items
    "itemStatus" : { CodeableConcept }, // The status of the items
    "countingDateTime" : "<dateTime>", // The date and time when the items were counted
    "items" : [{ // The item or items in this listing
      "category" : { CodeableConcept }, // The category of the item or items
      "quantity" : { Quantity }, // R!  The quantity of the item or items
      "item" : { CodeableReference(Device|Medication) }, // R!  The code or reference to the item type
      "lot" : "<string>", // The lot number of the item or items
      "serial" : "<string>", // The serial number of the item
      "expiry" : "<dateTime>", // The expiry date of the item or items
      "manufacturingDate" : "<dateTime>" // The manufacturingDate of the item or items
    }]
  }],
  "note" : { Annotation } // A note associated with the InventoryReport
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:InventoryReport.identifier [ Identifier ], ... ; # 0..* Identifiers for the report
  fhir:InventoryReport.status [ code ]; # 1..1 draft | requested | active | entered-in-error
  fhir:InventoryReport.countType [ code ]; # 1..1 snapshot | difference
  fhir:InventoryReport.operationType [ CodeableConcept ]; # 0..1 addition | subtraction
  fhir:InventoryReport.operationTypeReason [ CodeableConcept ]; # 0..1 The reason for this count - regular count, ad-hoc count, new arrivals, etc.
  fhir:InventoryReport.reportedDateTime [ dateTime ]; # 1..1 When the report has been submitted
  fhir:InventoryReport.reporter [ Reference(Device|Patient|Practitioner|RelatedPerson) ]; # 0..1 Who submits the report
  fhir:InventoryReport.reportingPeriod [ Period ]; # 0..1 The period the report refers to
  fhir:InventoryReport.inventoryListing [ # 0..* An inventory listing section (grouped by any of the attributes)
    fhir:InventoryReport.inventoryListing.location [ Reference(Location) ]; # 0..1 Location of the inventory items
    fhir:InventoryReport.inventoryListing.itemStatus [ CodeableConcept ]; # 0..1 The status of the items
    fhir:InventoryReport.inventoryListing.countingDateTime [ dateTime ]; # 0..1 The date and time when the items were counted
    fhir:InventoryReport.inventoryListing.items [ # 0..* The item or items in this listing
      fhir:InventoryReport.inventoryListing.items.category [ CodeableConcept ]; # 0..1 The category of the item or items
      fhir:InventoryReport.inventoryListing.items.quantity [ Quantity ]; # 1..1 The quantity of the item or items
      fhir:InventoryReport.inventoryListing.items.item [ CodeableReference(Device|Medication) ]; # 1..1 The code or reference to the item type
      fhir:InventoryReport.inventoryListing.items.lot [ string ]; # 0..1 The lot number of the item or items
      fhir:InventoryReport.inventoryListing.items.serial [ string ]; # 0..1 The serial number of the item
      fhir:InventoryReport.inventoryListing.items.expiry [ dateTime ]; # 0..1 The expiry date of the item or items
      fhir:InventoryReport.inventoryListing.items.manufacturingDate [ dateTime ]; # 0..1 The manufacturingDate of the item or items
    ], ...;
  ], ...;
  fhir:InventoryReport.note [ Annotation ]; # 0..1 A note associated with the InventoryReport
]

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
InventoryReport	TU		DomainResource	A report of inventory or stock items Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Identifiers for the report
status	?!Σ	1..1	code	draft \| requested \| active \| entered-in-error InventoryReportStatus (Required)
countType	?!Σ	1..1	code	snapshot \| difference InventoryCountType (Required)
operationType	Σ	0..1	CodeableConcept	addition \| subtraction
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
countingDateTime		0..1	dateTime	The date and time when the items were counted
items	Σ	0..*	BackboneElement	The item or items in this listing
category	Σ	0..1	CodeableConcept	The category of the item or items
quantity	Σ	1..1	Quantity	The quantity of the item or items
item	Σ	1..1	CodeableReference(Device \| Medication)	The code or reference to the item type
lot		0..1	string	The lot number of the item or items
serial		0..1	string	The serial number of the item
expiry		0..1	dateTime	The expiry date of the item or items
manufacturingDate		0..1	dateTime	The manufacturingDate of the item or items
note		0..1	Annotation	A note associated with the InventoryReport
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<InventoryReport xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifiers 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 CodeableConcept addition | subtraction --></operationType>
 <operationTypeReason><!-- 0..1 CodeableConcept 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 Reference(Device|Patient|Practitioner|RelatedPerson) Who submits the report --></reporter>
 <reportingPeriod><!-- 0..1 Period The period the report refers to --></reportingPeriod>
 <inventoryListing>  <!-- 0..* An inventory listing section (grouped by any of the attributes) -->
  <location><!-- 0..1 Reference(Location) Location of the inventory items --></location>
  <itemStatus><!-- 0..1 CodeableConcept The status of the items --></itemStatus>
  <countingDateTime value="[dateTime]"/><!-- 0..1 The date and time when the items were counted -->
  <items>  <!-- 0..* The item or items in this listing -->
   <category><!-- 0..1 CodeableConcept The category of the item or items --></category>
   <quantity><!-- 1..1 Quantity The quantity of the item or items --></quantity>
   <item><!-- 1..1 CodeableReference(Device|Medication) The code or reference to the item type --></item>
   <lot value="[string]"/><!-- 0..1 The lot number of the item or items -->
   <serial value="[string]"/><!-- 0..1 The serial number of the item -->
   <expiry value="[dateTime]"/><!-- 0..1 The expiry date of the item or items -->
   <manufacturingDate value="[dateTime]"/><!-- 0..1 The manufacturingDate of the item or items -->
  </items>
 </inventoryListing>
 <note><!-- 0..1 Annotation A note associated with the InventoryReport --></note>
</InventoryReport>

JSON Template

{
  "resourceType" : "InventoryReport",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers for the report
  "status" : "<code>", // R!  draft | requested | active | entered-in-error
  "countType" : "<code>", // R!  snapshot | difference
  "operationType" : { CodeableConcept }, // addition | subtraction
  "operationTypeReason" : { CodeableConcept }, // The reason for this count - regular count, ad-hoc count, new arrivals, etc.
  "reportedDateTime" : "<dateTime>", // R!  When the report has been submitted
  "reporter" : { Reference(Device|Patient|Practitioner|RelatedPerson) }, // Who submits the report
  "reportingPeriod" : { Period }, // The period the report refers to
  "inventoryListing" : [{ // An inventory listing section (grouped by any of the attributes)
    "location" : { Reference(Location) }, // Location of the inventory items
    "itemStatus" : { CodeableConcept }, // The status of the items
    "countingDateTime" : "<dateTime>", // The date and time when the items were counted
    "items" : [{ // The item or items in this listing
      "category" : { CodeableConcept }, // The category of the item or items
      "quantity" : { Quantity }, // R!  The quantity of the item or items
      "item" : { CodeableReference(Device|Medication) }, // R!  The code or reference to the item type
      "lot" : "<string>", // The lot number of the item or items
      "serial" : "<string>", // The serial number of the item
      "expiry" : "<dateTime>", // The expiry date of the item or items
      "manufacturingDate" : "<dateTime>" // The manufacturingDate of the item or items
    }]
  }],
  "note" : { Annotation } // A note associated with the InventoryReport
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:InventoryReport.identifier [ Identifier ], ... ; # 0..* Identifiers for the report
  fhir:InventoryReport.status [ code ]; # 1..1 draft | requested | active | entered-in-error
  fhir:InventoryReport.countType [ code ]; # 1..1 snapshot | difference
  fhir:InventoryReport.operationType [ CodeableConcept ]; # 0..1 addition | subtraction
  fhir:InventoryReport.operationTypeReason [ CodeableConcept ]; # 0..1 The reason for this count - regular count, ad-hoc count, new arrivals, etc.
  fhir:InventoryReport.reportedDateTime [ dateTime ]; # 1..1 When the report has been submitted
  fhir:InventoryReport.reporter [ Reference(Device|Patient|Practitioner|RelatedPerson) ]; # 0..1 Who submits the report
  fhir:InventoryReport.reportingPeriod [ Period ]; # 0..1 The period the report refers to
  fhir:InventoryReport.inventoryListing [ # 0..* An inventory listing section (grouped by any of the attributes)
    fhir:InventoryReport.inventoryListing.location [ Reference(Location) ]; # 0..1 Location of the inventory items
    fhir:InventoryReport.inventoryListing.itemStatus [ CodeableConcept ]; # 0..1 The status of the items
    fhir:InventoryReport.inventoryListing.countingDateTime [ dateTime ]; # 0..1 The date and time when the items were counted
    fhir:InventoryReport.inventoryListing.items [ # 0..* The item or items in this listing
      fhir:InventoryReport.inventoryListing.items.category [ CodeableConcept ]; # 0..1 The category of the item or items
      fhir:InventoryReport.inventoryListing.items.quantity [ Quantity ]; # 1..1 The quantity of the item or items
      fhir:InventoryReport.inventoryListing.items.item [ CodeableReference(Device|Medication) ]; # 1..1 The code or reference to the item type
      fhir:InventoryReport.inventoryListing.items.lot [ string ]; # 0..1 The lot number of the item or items
      fhir:InventoryReport.inventoryListing.items.serial [ string ]; # 0..1 The serial number of the item
      fhir:InventoryReport.inventoryListing.items.expiry [ dateTime ]; # 0..1 The expiry date of the item or items
      fhir:InventoryReport.inventoryListing.items.manufacturingDate [ dateTime ]; # 0..1 The manufacturingDate of the item or items
    ], ...;
  ], ...;
  fhir:InventoryReport.note [ Annotation ]; # 0..1 A note associated with the InventoryReport
]

Changes since Release 4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

12.29.4.1 Terminology Bindings

Path	Definition	Type	Reference
InventoryReport.status	The status of the InventoryReport.	Required	InventoryReportStatus
InventoryReport.countType	The type of count.	Required	InventoryCountType

Path

Definition

Type

Reference

InventoryReport.status

The status of the InventoryReport.

Required

InventoryReportStatus

InventoryReport.countType

The type of count.

Required

InventoryCountType