Deplete

Description

A Deplete event is used to indicate that a supply has been used, typically in a healthcare settings. The optional Patient object provides context for charging based on the supply usage, allowing for accurate tracking and billing of supplies used for individual patients.

API endpoints for Deplete

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/inventory/deplete.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Deplete

Deplete - Sample Payload

{
   "Meta": {
      "DataModel": "Inventory",
      "EventType": "Deplete",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "3ee0db2d-9664-4cb7-9778-b527e3af56fe",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "41f6b011-43b6-4998-b24d-cfa8c4d7d6aa",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "d51568fd-fa9c-4d2d-bf97-6a2641991c00",
            "AttemptID": "497731c5-0214-4372-8cea-47d099c7c3750"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "0094fb48-788f-41cb-9bc4-63aa8f0e9b58",
            "IDType": "EHRID"
         },
         {
            "ID": "7ed890a8-011e-42b3-877d-152850568cd3",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Ronnie",
         "MiddleName": "Patricks",
         "LastName": "Oliver",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+19088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Wallgate Avenue",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitNumber": null
   },
   "Items": [
      {
         "Identifiers": [
            {
               "ID": "22246069",
               "IDType": "SUPPLY"
            }
         ],
         "Description": "Special Gauze Sponges",
         "Quantity": 4,
         "Type": "Supply",
         "Units": "White Bandages",
         "Procedure": {
            "Code": null,
            "Codeset": null,
            "Modifier": null
         },
         "Notes": "Case of 2003",
         "Vendor": {
            "ID": "FSH",
            "Name": "SCIENTIFIC",
            "CatalogNumber": "22-246769"
         },
         "WastedQuantity": 1,
         "UsedQuantity": 3,
         "SerialNumber": null,
         "LotNumber": null,
         "Location": {
            "Facility": null,
            "Department": null,
            "ID": "Central",
            "Bin": "42"
         },
         "OrderingProvider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Allen",
            "LastName": "Parker",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "San Jose",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085441234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      }
   ]
}