# Inventory Update

This data model is for tracking surgical supplies (e.g., scalpels, bandages) between systems.

Inventory workflows are common for connecting to inpatient EHR systems with robust interfacing capabilities and surgical specialty modules. Supplies are often used in areas that function similarly to surgery (e.g., invasive cardiology, angiography). 

You can exchange inventory data with inventory management systems, the EHR system, or other system responsible for consuming supplies.

This data model has event types that allow you to:

- send administrative updates; or 
- document supply depletions.

> **EHR support for Inventory**
>
> Enterprise Resource Planner (ERP) systems typically support `Update` data via an HL7v2 MFN format or proprietary API. `Deplete` data is most commonly supported via an HL7v2 OMS or DFT format or proprietary API.

> **Inventory vs. Financial data model**
>
> Both data models contain administrative details with financial impact. 
>
> - `Inventory` focuses specifically on item usage and costs. 
> - `Financial` contains patient charges, which can include inventory-related charges.

Send an administrative message to synchronize types, counts, locations, and prices across systems. This event is triggered when database updates are made in the inventory management system.

The `Update` event is for reading and writing supply metadata. For example, how many items are on hand, whether or not an item is chargeable, and where the supply is located. 

This message typically comes from the Enterprise Resource Planner (ERP) into the EHR system, including the types of items stocked and the specific locations in the hospital they might be found. 

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Inventory |
| `Meta.EventType` | string | Yes | Update |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional. *UUID* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination. *Required when sending data to Redox.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference. *UUID* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | Code for the facility related to the message. *Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.* |
| `Items` | Array of object | Yes |  |
| `Items[].Identifiers` | Array of object | Yes |  |
| `Items[].Identifiers[].ID` | string | Yes | The identifier list for an item can contain multiple aliases, including the application ID for the item, an external ordering system's ID, or the an ID that the health system uses to identify the item across systems. |
| `Items[].Identifiers[].IDType` | string | Yes | The type of identifier in Item.Identifiers[].ID. *This is usually a string that roughly corresponds to which application assigned the ID. Example: Redox, Lawson, RedoxHealthSystem* |
| `Items[].Description` | string or null | No | A free text description of the item name. *Used to show a human-readable version of the item, or for lookup.. * |
| `Items[].Quantity` | number or null | No | The quantity of the item being referred to. For update messages, this usually refers to the quantity on hand, for requisition messages, this is the number used/ordered. |
| `Items[].Type` | string or null | No | What kind of item this is (Equipment, Supply, Implant, Medication). *This is used primary for filtering. * |
| `Items[].Units` | string or null | No | The unit of measure for the item. Examples: Box, Pack, Syringe, etc. *Different products are ordered/used in different quantities. For example, you may buy a case of gauze, and those are used as packages.* |
| `Items[].Procedure` | object | No |  |
| `Items[].Procedure.Code` | string or null | No | A procedure attached to the item. This is usually a HCPCS code that is used to bill for the item. |
| `Items[].Procedure.Codeset` | string or null | No | Codeset of the procedure. |
| `Items[].Procedure.Modifier` | string or null | No | A modifier (if applicable), usually used in conjunction with the HCPCS code. |
| `Items[].Notes` | string or null | No | Free text comments about the item. |
| `Items[].Vendor` | object | No | Information about the specific vendor that the item is from. |
| `Items[].Vendor.ID` | string or null | No | The ID for the vendor that would be used in automated purchase system. |
| `Items[].Vendor.Name` | string or null | No | A name/description of the vendor. |
| `Items[].Vendor.CatalogNumber` | string or null | No | The Vendor's ID for the item. This will be used in any kind of automated purchase system. |
| `Items[].Status` | string or null | No | Status indicates whether the item is active, discontinued, or not stocked. |
| `Items[].IsChargeable` | boolean or null | No | Indicate whether or not this item can be charged for, usually used in conjunction with Items[].Procedure. |
| `Items[].ContainsLatex` | boolean or null | No | A flag indicating whether or not the product contains latex. |
| `Items[].Price` | number or null | No | A field for price of the product. This is typically used for reporting purposes. |
| `Items[].Location` | object | No | Where the item is physically stored in the healthcare facility. |
| `Items[].Location.Facility` | string or null | No | *Example: Community Hospital* |
| `Items[].Location.Department` | string or null | No | Department where the item is physically stored. |
| `Items[].Location.ID` | string or null | No | An identifier for the location of the product - this can correspond to one of multiple store rooms in a particular facility, or the facility itself. |
| `Items[].Location.Bin` | string or null | No | An further identifier for where the item is located. |

## Example

```json
{
  "Meta": {
    "DataModel": "Inventory",
    "EventType": "Update",
    "EventDateTime": "2026-11-18T19:05:05.809Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Items": [
    {
      "Identifiers": [
        {
          "ID": "22246069",
          "IDType": "SUPPLY"
        }
      ],
      "Description": "Gauze Sponges",
      "Quantity": 4,
      "Type": "Supply",
      "Units": "Bandages",
      "Procedure": {
        "Code": null,
        "Codeset": null,
        "Modifier": null
      },
      "Notes": "Case of 2000",
      "Vendor": {
        "ID": "FSH",
        "Name": "FISHER SCIENTIFIC",
        "CatalogNumber": "22-246069"
      },
      "Status": "Active",
      "IsChargeable": false,
      "ContainsLatex": false,
      "Price": 118.9,
      "Location": {
        "Facility": null,
        "Department": null,
        "ID": "Central",
        "Bin": "42"
      }
    }
  ]
}
```
