UsageItems
Get the list of Usage Items
Path
GET /odata/UsageItems
Description
Returns the paged list of existing items within all Usages. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).
Note
This endpoint does not support logical operators (and, or, in, gt, ge, lt, le) for data filtering.
Request parameters
Parameter |
Explanation |
|---|---|
| summary: boolean default: false in query |
Set to true if you want to apply Grouping. |
| from: string (date-time) in query |
Enter the start date here. |
| to: string (date-time) in query |
Enter the end date here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| $search: string in query |
Picks the value in all possible fields. |
| $filter: string in query |
Filters the results, based on a Boolean condition. |
| $orderby: string in query |
Sorts the results. |
| $top: string in query |
Returns only the first n results. |
| $skip: string in query |
Skips the first n results. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 400 Bad Request | The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| usageItemId: string (uuid) | Unique Identifier of the Usage |
| procedureCode1: string | First Code of the Procedure |
| procedureName1: string | First Name of the Procedure |
| procedureCode2: string | Second Code of the Procedure |
| procedureName2: string | Second Name of the Procedure |
| procedure1Id: string (uuid) | Unique Identifier of the first Procedure |
| procedure2Id: string (uuid) | Unique Identifier of the second Procedure |
| date: string (date-time) | Usage Date |
| caseNo: string | Number of the Case |
| facilityId: string (uuid) | Unique Identifier of the Facility |
| departmentName: string | Name of the Department |
| departmentId: string (uuid) | Unique Identifier of the Department |
| extendedPrice: number (double) | Extended Price |
| cost: number (double) | Cost |
| extendedCost: number (double) | Extended Cost |
| patient: string | Patient Details |
| facilityName: string | Name of the Facility |
| facilityNo: string | Identification Number of the Facility |
| doctorName: string | Name of the Doctor |
| doctorId: string (uuid) | Unique Identifier of the Doctor |
| vendorItemNo: string | Code that is used by the Vendor for the Item identification |
| inventoryDescription: string | Description of the Inventory Item |
| classification: string | Category of the Item defined on the Organization level |
| classification2: string | Additional Category of the Item defined on the Organization level |
| quantity: integer (int32) | Quantity of the Usage Item |
| uom: string | Unit of Measure |
| price: number (double) | Price of the Usage Item |
| conversionFactor: integer (int32) | Number of Stock Keeping Units in another Unit of Measure |
| locationNo: string | Identification Number of the Location |
| inventoryNo: string | Identification code of the Inventory Item |
| manufacturerNo: string | Number of the Manufacturer |
| manufacturerItemNo: string | Number of the Manufacturer Item |
| lotNo: string | Identification Number assigned to a particular Quantity or Lot of material from a single Manufacturer |
| serialNo: string | Unique Identifier assigned incrementally or sequentially to an Item to uniquely identify it |
| expirationDate: string (date-time) |
Previously determined date after which Item should no longer be used |
| itemNotes: string | Comments about the Item |
| lineNo: integer (int32) | Number of the Line Item |
| usageOrdinalNo: integer (int32) | Ordinal Number of the Usage |
| usageId: string (uuid) | Unique Identifier of the Usage |
| usageNo: string | Identification Number of the Location |
| dateSubmitted: string (date-time) | Date when Usage was submitted |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"usageItemId": "00000000-0000-0000-0000-000000000000",
"procedureCode1": "string",
"procedureName1": "string",
"procedureCode2": "string",
"procedureName2": "string",
"procedure1Id": "00000000-0000-0000-0000-000000000000",
"procedure2Id": "00000000-0000-0000-0000-000000000000",
"date": "string (date-time)",
"caseNo": "string",
"facilityId": "00000000-0000-0000-0000-000000000000",
"departmentName": "string",
"departmentId": "00000000-0000-0000-0000-000000000000",
"extendedPrice": "number (double)",
"cost": "number (double)",
"extendedCost": "number (double)",
"patient": "string",
"facilityName": "string",
"facilityNo": "string",
"doctorName": "string",
"doctorId": "00000000-0000-0000-0000-000000000000",
"vendorItemNo": "string",
"inventoryDescription": "string",
"classification": "string",
"classification2": "string",
"quantity": "integer (int32)",
"uom": "string",
"price": "number (double)",
"conversionFactor": "integer (int32)",
"locationNo": "string",
"inventoryNo": "string",
"manufacturerNo": "string",
"manufacturerItemNo": "string",
"lotNo": "string",
"serialNo": "string",
"expirationDate": "string (date-time)",
"itemNotes": "string",
"lineNo": "integer (int32)",
"usageOrdinalNo": "integer (int32)",
"usageId": "00000000-0000-0000-0000-000000000000",
"usageNo": "string",
"dateSubmitted": "string (date-time)"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Add new Items to existing Usages
Path
POST /odata/UsageItems/BulkAdd
Description
Adds new items to existing Usages within a logged organization.
Request body
Parameter |
Explanation |
|---|---|
| usageId: string required in formData |
Unique Identifier of the Usage. If not provided: 400 Bad Request. |
| lineNo: integer (int32) in formData |
Number of the Line Item. It is generated automatically and recalculated within active Usage Line Items. If not provided: Auto-populated. |
| inventoryNo: string in formData |
Identification code of the Inventory Item. It is validated by Facility (Inventory Group). If not provided: Empty. |
| inventoryDescription: string in formData |
Description of the Inventory Item. It is populated from the existing Inventory if it is mapped by the Inventory No and Inventory Locations values. If not provided: Empty. |
| locationNo: string required in formData |
Identification Number of the Location. It is populated from locationNo if the specified Location exists within Usage Facility. If not provided: Usage Default Location. |
| vendorItemNo: string in formData |
Code that is used by the Vendor for the Item identification. It is matched with appropriate Inventory Vendor data. If not provided: Empty. |
| manufacturerNo: string in formData |
Number of the Manufacturer. It is populated from Inventory Vendor if Item is matched by vendorItemNo. If not provided: none. |
| manufacturerItemNo: string in formData |
Item Number of the Manufacturer. It is populated from Inventory Vendor if Item is matched by vendorItemNo. If not provided: Empty. |
| lotNo: string in formData |
Identification Number assigned to a particular Quantity or Lot of material from a single Manufacturer. It is populated from lotNo. If not provided: Empty. |
| serialNo: string in formData |
Unique Identifier assigned incrementally or sequentially to an Item to uniquely identify it. It is populated from serialNo . If not provided: Empty. |
| expirationDate: string in formData |
Previously determined date after which Item should no longer be used. It is populated from expirationDate .If not provided: Empty. |
| quantity: string in formData |
Quantity specified in the Line Items. If not provided: 1. |
| uom: string in formData |
Unit of Measure. It can be matched with Inventory UOM. If not provided: EA. |
| conversionFactor: string in formData |
Number of Stock Keeping Units in another Unit of Measure. It is populated from appropriate Inventory UOM Conversion Factor if Item is added as Inventory Item, and the specified UOM value is matched with Inventory UOM If not provided: 1. |
| itemNotes: string in formData |
Comments about the Item. It is populated from Item Notes If not provided: Empty. |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example
Request Example
{
"usageId": "string(uuid)",
"lineNo": "integer (int32)",
"inventoryNo": "string",
"inventoryDescription": "string",
"locationNo": "string",
"vendorItemNo": "string",
"manufacturerItemNo": "string",
"lotNo": "string",
"serialNo": "string",
"expirationDate": "string",
"quantity": "string",
"uom": "string",
"conversionFactor": "string",
"itemNotes": "string"
}
Request Example
{
"usageItems":[
{
"usageId": "UsageId1"
},
{
"usageId": "UsageId2"
},
{
"usageId": "UsageId3"
}
]
}
Request parameters
Parameter |
Explanation |
|---|---|
| api-version: string default: 1.0 in header |
The requested API version. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |