This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions
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)
Structure
| Name | Flags | Card. | Type | Description & Constraints doco |
|---|---|---|---|---|
| .. 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 | Business identifier for the report |
| ... status | ?! Σ | 1..1 | code | draft | requested | active | entered-in-error Binding: Inventory Report Status (Required) |
| ... countType | ?! Σ | 1..1 | code | snapshot | difference Binding: Inventory Count Type (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 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 | Medication | NutritionProduct | InventoryItem | BiologicallyDerivedProduct | InventoryItem) | The code or reference to the item type |
| ... note | 0..* | Annotation | A note associated with the InventoryReport | |
doco Documentation for this format icon | ||||
See the Extensions for this resource
UML Diagram (Legend)
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 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 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 that are being reported --></itemStatus> <countingDateTime value="[dateTime ]"/><!-- 0..1 The date and time when the items were counted --> <item> <!-- 0..* The item or items in this listing --> <category><!-- 0..1 CodeableConcept The inventory category or classification of the items being reported --></category> <quantity><!-- 1..1 Quantity The quantity of the item or items being reported --></quantity> <item><!-- 1..1 CodeableReference(BiologicallyDerivedProduct|Device| InventoryItem|InventoryItem|Medication|Medication|NutritionProduct) The code or reference to the item type --></item> </item> </inventoryListing> <note><!-- 0..* 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 }], // Business identifier 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 that are being reported
"countingDateTime" : "<dateTime >", // The date and time when the items were counted
"item" : [{ // The item or items in this listing
"category" : { CodeableConcept }, // The inventory category or classification of the items being reported
"quantity" : { Quantity }, // R! The quantity of the item or items being reported
"item" : { CodeableReference(BiologicallyDerivedProduct|Device|
InventoryItem|InventoryItem|Medication|Medication|NutritionProduct) } // R! The code or reference to the item type
}]
}],
"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: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( [ # 0..* An inventory listing section (grouped by any of the attributes) fhir:location[ Reference(Location) ] ; # 0..1 Location of the inventory items fhir:itemStatus[ CodeableConcept ] ; # 0..1 The status of the items that are being reported fhir:countingDateTime[ dateTime ] ; # 0..1 The date and time when the items were counted fhir:item( [ # 0..* The item or items in this listing fhir:category[ CodeableConcept ] ; # 0..1 The inventory category or classification of the items being reported fhir:quantity[ Quantity ] ; # 1..1 The quantity of the item or items being reported fhir:item[ CodeableReference(BiologicallyDerivedProduct|Device|InventoryItem|InventoryItem|Medication| Medication|NutritionProduct) ] ; # 1..1 The code or reference to the item type ] ... ) ; ] ... ) ; fhir:note ( [ Annotation ] ... ) ; # 0..* A note associated with the InventoryReport ]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
| Name | Flags | Card. | Type | Description & Constraints doco |
|---|---|---|---|---|
| .. 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 | Business identifier for the report |
| ... status | ?! Σ | 1..1 | code | draft | requested | active | entered-in-error Binding: Inventory Report Status (Required) |
| ... countType | ?! Σ | 1..1 | code | snapshot | difference Binding: Inventory Count Type (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 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 | Medication | NutritionProduct | InventoryItem | BiologicallyDerivedProduct | InventoryItem) | The code or reference to the item type |
| ... note | 0..* | Annotation | A note associated with the InventoryReport | |
doco Documentation for this format icon | ||||
See the Extensions for this resource
UML Diagram (Legend)
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 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 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 that are being reported --></itemStatus> <countingDateTime value="[dateTime ]"/><!-- 0..1 The date and time when the items were counted --> <item> <!-- 0..* The item or items in this listing --> <category><!-- 0..1 CodeableConcept The inventory category or classification of the items being reported --></category> <quantity><!-- 1..1 Quantity The quantity of the item or items being reported --></quantity> <item><!-- 1..1 CodeableReference(BiologicallyDerivedProduct|Device| InventoryItem|InventoryItem|Medication|Medication|NutritionProduct) The code or reference to the item type --></item> </item> </inventoryListing> <note><!-- 0..* 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 }], // Business identifier 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 that are being reported
"countingDateTime" : "<dateTime >", // The date and time when the items were counted
"item" : [{ // The item or items in this listing
"category" : { CodeableConcept }, // The inventory category or classification of the items being reported
"quantity" : { Quantity }, // R! The quantity of the item or items being reported
"item" : { CodeableReference(BiologicallyDerivedProduct|Device|
InventoryItem|InventoryItem|Medication|Medication|NutritionProduct) } // R! The code or reference to the item type
}]
}],
"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: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( [ # 0..* An inventory listing section (grouped by any of the attributes) fhir:location[ Reference(Location) ] ; # 0..1 Location of the inventory items fhir:itemStatus[ CodeableConcept ] ; # 0..1 The status of the items that are being reported fhir:countingDateTime[ dateTime ] ; # 0..1 The date and time when the items were counted fhir:item( [ # 0..* The item or items in this listing fhir:category[ CodeableConcept ] ; # 0..1 The inventory category or classification of the items being reported fhir:quantity[ Quantity ] ; # 1..1 The quantity of the item or items being reported fhir:item[ CodeableReference(BiologicallyDerivedProduct|Device|InventoryItem|InventoryItem|Medication| Medication|NutritionProduct) ] ; # 1..1 The code or reference to the item type ] ... ) ; ] ... ) ; fhir:note ( [ Annotation ] ... ) ; # 0..* A note associated with the InventoryReport ]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B 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
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| InventoryReport.status | InventoryReportStatus | Required | The status of the InventoryReport. |
| InventoryReport.countType | InventoryCountType | Required | The type of count. |
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.