Skip to main content

InventoryItem

Draft Other

functional description of an inventory item used in inventory and supply-related workflows.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/InventoryItem
InteractionMethodPath
ReadGET/fhir/R5/InventoryItem/[id]
VreadGET/fhir/R5/InventoryItem/[id]/_history/[vid]
UpdatePUT/fhir/R5/InventoryItem/[id]
PatchPATCH/fhir/R5/InventoryItem/[id]
DeleteDELETE/fhir/R5/InventoryItem/[id]
CreatePOST/fhir/R5/InventoryItem
SearchGET/fhir/R5/InventoryItem?...
HistoryGET/fhir/R5/InventoryItem/[id]/_history
Type-historyGET/fhir/R5/InventoryItem/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business identifier for the inventory item
statuscode1..1active
categoryCodeableConcept0..*Category or class of the item
codeCodeableConcept0..*Code designating the specific type of item
nameBackboneElement0..*The item name(s) - the brand name, or common name, functional name, generic name or others
responsibleOrganizationBackboneElement0..*Organization(s) responsible for the product
descriptionBackboneElement0..1Descriptive characteristics of the item
inventoryStatusCodeableConcept0..*The usage status like recalled, in use, discarded
baseUnitCodeableConcept0..1The base unit of measure - the unit in which the product is used or counted
netContentQuantity0..1Net content or amount present in the item
associationBackboneElement0..*Association with other items or products
characteristicBackboneElement0..*Characteristic of the item
instanceBackboneElement0..1Instances or occurrences of the product
productReferenceReference0..1Link to a product resource used in clinical workflows

Resource-specific search parameters

ParameterTypeDescription
codetokenSearch for products that match this code
identifiertokenThe identifier of the item
statustokenThe status of the item
subjectreferenceThe identity of a patient for whom to list associations

Reference