Release 5 Preview #3

12.27 Resource InventoryReport - Content

Orders and Observations Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

A report of inventory or stock items.

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

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.

No resources refer to this resource directly.

This resource implements the Event pattern.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryReport TUDomainResourceA report of inventory or stock items
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierIdentifiers for the report
... status ?!Σ1..1codedraft | requested | active | entered-in-error
InventoryReportStatus (Required)
... countType ?!Σ1..1codesnapshot | difference
InventoryCountType (Required)
... operationTypeReason Σ0..1CodeableConceptThe reason for this count - regular count, ad-hoc count, new arrivals, etc.
... reportedDateTime Σ1..1dateTimeWhen the report has been submitted
... reporter 0..1Reference(Practitioner | Patient | RelatedPerson | Device)Who submits the report
... reportingPeriod 0..1PeriodThe period the report refers to
... inventoryListing Σ0..*BackboneElementAn inventory listing section (grouped by any of the attributes)
.... location 0..1Reference(Location)Location of the inventory items
.... itemStatus Σ0..1CodeableConceptThe status of the items
.... countingDateTime 0..1dateTimeThe date and time when the items were counted
.... items Σ0..*BackboneElementThe item or items in this listing
..... category Σ0..1CodeableConceptThe category of the item or items
..... quantity Σ1..1QuantityThe quantity of the item or items
..... item Σ1..1CodeableReference(Device | Medication)The code or reference to the item type
..... lot 0..1stringThe lot number of the item or items
..... serial 0..1stringThe serial number of the item
..... expiry 0..1dateTimeThe expiry date of the item or items
..... manufacturingDate 0..1dateTimeThe manufacturingDate of the item or items
... note 0..1AnnotationA note associated with the InventoryReport

doco Documentation for this format

UML Diagram (Legend)

InventoryReport (DomainResource)Identifiers for the InventoryReportidentifier : Identifier [0..*]The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active (this element modifies the meaning of other elements)status : code [1..1] « The status of the InventoryReport. (Strength=Required)InventoryReportStatus! »Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change) (this element modifies the meaning of other elements)countType : code [1..1] « The type of count. (Strength=Required)InventoryCountType! »What type of operation is being performed - addition or subtractionoperationType : CodeableConcept [0..1]The reason for this count - regular count, ad-hoc count, new arrivals, etcoperationTypeReason : CodeableConcept [0..1]When the report has been submittedreportedDateTime : dateTime [1..1]Who submits the reportreporter : Reference [0..1] « Practitioner|Patient|RelatedPerson| Device »The period the report refers toreportingPeriod : Period [0..1]A note associated with the InventoryReportnote : Annotation [0..1]InventoryListingLocation of the inventory itemslocation : Reference [0..1] « Location »The status of the itemsitemStatus : CodeableConcept [0..1]The date and time when the items were countedcountingDateTime : dateTime [0..1]ItemsThe category of the item or itemscategory : CodeableConcept [0..1]The quantity of the item or itemsquantity : Quantity [1..1]The code or reference to the item typeitem : DataType [1..1] « Device|Medication »The lot number of the item or itemslot : string [0..1]The serial number of the itemserial : string [0..1]The expiry date of the item or itemsexpiry : dateTime [0..1]The manufacturingDate of the item or itemsmanufacturingDate : dateTime [0..1]The item or items in this listingitems[0..*]An inventory listing section (grouped by any of the attributes)inventoryListing[0..*]

XML Template

<InventoryReport xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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 R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryReport TUDomainResourceA report of inventory or stock items
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierIdentifiers for the report
... status ?!Σ1..1codedraft | requested | active | entered-in-error
InventoryReportStatus (Required)
... countType ?!Σ1..1codesnapshot | difference
InventoryCountType (Required)
... operationTypeReason Σ0..1CodeableConceptThe reason for this count - regular count, ad-hoc count, new arrivals, etc.
... reportedDateTime Σ1..1dateTimeWhen the report has been submitted
... reporter 0..1Reference(Practitioner | Patient | RelatedPerson | Device)Who submits the report
... reportingPeriod 0..1PeriodThe period the report refers to
... inventoryListing Σ0..*BackboneElementAn inventory listing section (grouped by any of the attributes)
.... location 0..1Reference(Location)Location of the inventory items
.... itemStatus Σ0..1CodeableConceptThe status of the items
.... countingDateTime 0..1dateTimeThe date and time when the items were counted
.... items Σ0..*BackboneElementThe item or items in this listing
..... category Σ0..1CodeableConceptThe category of the item or items
..... quantity Σ1..1QuantityThe quantity of the item or items
..... item Σ1..1CodeableReference(Device | Medication)The code or reference to the item type
..... lot 0..1stringThe lot number of the item or items
..... serial 0..1stringThe serial number of the item
..... expiry 0..1dateTimeThe expiry date of the item or items
..... manufacturingDate 0..1dateTimeThe manufacturingDate of the item or items
... note 0..1AnnotationA note associated with the InventoryReport

doco Documentation for this format

UML Diagram (Legend)

InventoryReport (DomainResource)Identifiers for the InventoryReportidentifier : Identifier [0..*]The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active (this element modifies the meaning of other elements)status : code [1..1] « The status of the InventoryReport. (Strength=Required)InventoryReportStatus! »Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change) (this element modifies the meaning of other elements)countType : code [1..1] « The type of count. (Strength=Required)InventoryCountType! »What type of operation is being performed - addition or subtractionoperationType : CodeableConcept [0..1]The reason for this count - regular count, ad-hoc count, new arrivals, etcoperationTypeReason : CodeableConcept [0..1]When the report has been submittedreportedDateTime : dateTime [1..1]Who submits the reportreporter : Reference [0..1] « Practitioner|Patient|RelatedPerson| Device »The period the report refers toreportingPeriod : Period [0..1]A note associated with the InventoryReportnote : Annotation [0..1]InventoryListingLocation of the inventory itemslocation : Reference [0..1] « Location »The status of the itemsitemStatus : CodeableConcept [0..1]The date and time when the items were countedcountingDateTime : dateTime [0..1]ItemsThe category of the item or itemscategory : CodeableConcept [0..1]The quantity of the item or itemsquantity : Quantity [1..1]The code or reference to the item typeitem : DataType [1..1] « Device|Medication »The lot number of the item or itemslot : string [0..1]The serial number of the itemserial : string [0..1]The expiry date of the item or itemsexpiry : dateTime [0..1]The manufacturingDate of the item or itemsmanufacturingDate : dateTime [0..1]The item or items in this listingitems[0..*]An inventory listing section (grouped by any of the attributes)inventoryListing[0..*]

XML Template

<InventoryReport xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
InventoryReport.status The status of the InventoryReport.RequiredInventoryReportStatus
InventoryReport.countType The type of count.RequiredInventoryCountType