Inventory

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

Update

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 Schema

Show Required Fields Only

Show Translation Fields

Meta
required, object
- DataModel
  required, string
  Reliable
  Inventory
- EventType
  required, string
  Reliable
  Update
- EventDateTime
  string, null
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Test
  boolean, null
  Reliable
  Indicates whether the request is a test or not.
- Source
  object
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
  ID
  string, null
  Reliable
  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
  Name
  string, null
  Reliable
  Displays the name of the system initiating the message.
- Destinations
  Array of object
  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.
  ID
  string, null
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
  Name
  string, null
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Logs
  Array of object
  Contains the log identifier(s) for the request.
  ID
  string, null
  Reliable
  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
  AttemptID
  string, null
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- FacilityCode
  string, null
  Possible
  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
required, Array of object
- Identifiers
  required, Array of object
  ID
  required, string
  Reliable
  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.
  IDType
  required, string
  Reliable
  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
- Description
  string, null
  Probable
  A free text description of the item name.
  *Used to show a human-readable version of the item, or for lookup.. *
- Quantity
  number, null
  Probable
  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.
- Type
  string, null
  Probable
  What kind of item this is (Equipment, Supply, Implant, Medication).
  *This is used primary for filtering. *
- Units
  string, null
  Probable
  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.
- Procedure
  object
  Code
  string, null
  Probable
  A procedure attached to the item. This is usually a HCPCS code that is used to bill for the item.
  Codeset
  string, null
  Probable
  Codeset of the procedure.
  Modifier
  string, null
  Probable
  A modifier (if applicable), usually used in conjunction with the HCPCS code.
- Notes
  string, null
  Probable
  Free text comments about the item.
- Vendor
  object
  Information about the specific vendor that the item is from.
  ID
  string, null
  Probable
  The ID for the vendor that would be used in automated purchase system.
  Name
  string, null
  Probable
  A name/description of the vendor.
  CatalogNumber
  string, null
  Probable
  The Vendor's ID for the item. This will be used in any kind of automated purchase system.
- Status
  string, null
  Probable
  Status indicates whether the item is active, discontinued, or not stocked.
- IsChargeable
  boolean, null
  Probable
  Indicate whether or not this item can be charged for, usually used in conjunction with Items[].Procedure.
- ContainsLatex
  boolean, null
  Probable
  A flag indicating whether or not the product contains latex.
- Price
  number, null
  Probable
  A field for price of the product. This is typically used for reporting purposes.
- Location
  object
  Where the item is physically stored in the healthcare facility.
  Facility
  string, null
  Probable
  Example: Community Hospital
  Department
  string, null
  Probable
  Department where the item is physically stored.
  ID
  string, null
  Probable
  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.
  Bin
  string, null
  Probable
  An further identifier for where the item is located.

Example

json

1
{
2
  "Meta": {
3
    "DataModel": "Inventory",
4
    "EventType": "Update",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Items": [
26
    {
27
      "Identifiers": [
28
        {
29
          "ID": "22246069",
30
          "IDType": "SUPPLY"
31
        }
32
      ],
33
      "Description": "Gauze Sponges",
34
      "Quantity": 4,
35
      "Type": "Supply",
36
      "Units": "Bandages",
37
      "Procedure": {
38
        "Code": null,
39
        "Codeset": null,
40
        "Modifier": null
41
      },
42
      "Notes": "Case of 2000",
43
      "Vendor": {
44
        "ID": "FSH",
45
        "Name": "FISHER SCIENTIFIC",
46
        "CatalogNumber": "22-246069"
47
      },
48
      "Status": "Active",
49
      "IsChargeable": false,
50
      "ContainsLatex": false,
51
      "Price": 118.9,
52
      "Location": {
53
        "Facility": null,
54
        "Department": null,
55
        "ID": "Central",
56
        "Bin": "42"
57
      }
58
    }
59
  ]
60
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.