POST API/V1/Orders/Drafts
Request Information
URI Parameters
None.
Body Parameters
Collection of iMDsoft.API.Metavision.Data.Orders.ExternalOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| IsHomeMedication |
Indicates whether the patient was taking this medication before admission. |
boolean |
None. |
| OrderingStyle |
Represents the ordering style in the MetaVision order. |
iMDsoft.API.Metavision.Data.Orders.OrderingStyleEnum |
None. |
| IsUnplanned |
Only used during GET. Indicates whether the order represents a planned order or an unplanned (orphan) dose. |
boolean |
None. |
| PatternItems |
The number of pattern items (combined with the frequency information provided in the pattern item's timing) can determine whether the order is treated as a pattern order, or whether it is with pattern mode off. |
Collection of iMDsoft.API.Metavision.Data.Orders.PatternItem |
None. |
| DetectedIssues |
Detected issues - currently used for patient order allergy conflicts |
Collection of iMDsoft.API.Metavision.Data.Orders.DetectedIssue |
None. |
| LogEntries |
Only used for Get Orders, toggled via URI parameter "includeOrderLog". If enabled, returns the order and all actions performed on it row by row along with the ordering and issuing users, time, old value, and new value. Not used for drafts or posting orders. |
Collection of iMDsoft.API.Metavision.Data.Orders.LogEntry |
None. |
| EncounterInfo |
Patient identifier |
iMDsoft.API.Metavision.Data.Orders.EncounterInfo |
None. |
| OrderId |
MetaVision order ID. |
string |
None. |
| OrderGUID |
If orderID is GUID, will be used as the order GUID when posting to the Shopping Cart. |
string |
None. |
| Route |
Route, e.g. "IV" or "Per Os". |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Location |
Location e.g. "left arm". |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| PRN |
PRN details. |
iMDsoft.API.Metavision.Data.Orders.PRNElements |
None. |
| OrderedBy |
When getting orders, the user on whose behalf the order was created. Not used for drafts or posting orders. |
string |
None. |
| IssuedBy |
When getting orders, the user who entered the order. Not used for drafts or posting orders. |
string |
None. |
| Comment |
Additional instructions/comments for the order |
string |
None. |
| OrderSummary |
Human readable fallback data with all the information needed to create an order in case any details were not successfully translated. |
string |
None. |
| Caption |
A caption is an alias name for the order. For example, “TPN” may describe an order that contains multiple medications combined as a single order. |
string |
None. |
| Status |
When getting orders, specifies the current state of the order. Can be one of the following: in-progress | on-hold | completed | entered-in-error | stopped. In-progress status is returned for both "pending" and "active" orders. Not used for drafts or posting orders. When posting orders, on-hold orders will be entered as held into the shopping cart. |
string |
None. |
| StatusReason |
When getting orders, reason for the current status. Can be blank. For example, "Pending re-evaluation". Always blank in MetaVision version 6.11. Completed orders and unplanned orders do not support having a reason. Not used for drafts or posting orders. |
string |
None. |
| StatusComment |
When getting orders, additional comments accompanying the status reason. For example, "Awaiting lab results before deciding whether to resume or stop the order." Always blank in MetaVision version 6.11. Completed orders and unplanned orders do not support having a reason. Not used for drafts or posting orders. |
string |
None. |
| IsSelfAdministered |
Indicates whether the order is self administered. |
boolean |
None. |
| DbTimeStamp |
SQL time stamp |
Collection of byte |
None. |
| Effective |
Represents the planned start date & time and end method of an order |
iMDsoft.API.Metavision.Data.Orders.Effective |
None. |
| LastUpdated |
The last update time of the order |
date |
None. |
| OriginalOrderData |
The original order data |
string |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"encounterInfo": {
"mrNumber": "sample string 1",
"accountNumber": "sample string 2"
},
"orderId": "sample string 3",
"orderGUID": "sample string 4",
"route": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"location": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"prn": {
"isPRN": true,
"instruction": "sample string 2",
"maxDispensePer24h": 1,
"maxDispensePer24hUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"orderedBy": "sample string 5",
"issuedBy": "sample string 6",
"comment": "sample string 8",
"orderSummary": "sample string 9",
"caption": "sample string 10",
"status": "sample string 11",
"statusReason": "sample string 12",
"statusComment": "sample string 13",
"isSelfAdministered": true,
"dbTimeStamp": "QEA=",
"effective": {
"startDateTime": "2024-09-22T13:25:40.6376431+03:00",
"endDateTime": "2024-09-22T13:25:40.6376431+03:00",
"endNumberOfDoses": 1
},
"lastUpdated": "2024-09-22T13:25:40.6376431+03:00",
"originalOrderData": "sample string 15",
"isHomeMedication": true,
"orderingStyle": "None",
"isUnplanned": true,
"patternItems": [
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6376431+03:00",
"2024-09-22T13:25:40.6376431+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
},
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6376431+03:00",
"2024-09-22T13:25:40.6376431+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
}
],
"detectedIssues": [
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
},
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
}
],
"logEntries": [
{
"time": "2024-09-22T13:25:40.6376431+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
}
]
},
{
"time": "2024-09-22T13:25:40.6376431+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
}
]
}
]
},
{
"encounterInfo": {
"mrNumber": "sample string 1",
"accountNumber": "sample string 2"
},
"orderId": "sample string 3",
"orderGUID": "sample string 4",
"route": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"location": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"prn": {
"isPRN": true,
"instruction": "sample string 2",
"maxDispensePer24h": 1,
"maxDispensePer24hUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"orderedBy": "sample string 5",
"issuedBy": "sample string 6",
"comment": "sample string 8",
"orderSummary": "sample string 9",
"caption": "sample string 10",
"status": "sample string 11",
"statusReason": "sample string 12",
"statusComment": "sample string 13",
"isSelfAdministered": true,
"dbTimeStamp": "QEA=",
"effective": {
"startDateTime": "2024-09-22T13:25:40.6376431+03:00",
"endDateTime": "2024-09-22T13:25:40.6376431+03:00",
"endNumberOfDoses": 1
},
"lastUpdated": "2024-09-22T13:25:40.6376431+03:00",
"originalOrderData": "sample string 15",
"isHomeMedication": true,
"orderingStyle": "None",
"isUnplanned": true,
"patternItems": [
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6376431+03:00",
"2024-09-22T13:25:40.6376431+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
},
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6376431+03:00",
"2024-09-22T13:25:40.6376431+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
}
],
"detectedIssues": [
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
},
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
}
],
"logEntries": [
{
"time": "2024-09-22T13:25:40.6376431+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
}
]
},
{
"time": "2024-09-22T13:25:40.6376431+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6376431+03:00",
"issuedBy": "sample string 5"
}
]
}
]
}
]
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of iMDsoft.API.Metavision.Data.Orders.ExternalOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| IsHomeMedication |
Indicates whether the patient was taking this medication before admission. |
boolean |
None. |
| OrderingStyle |
Represents the ordering style in the MetaVision order. |
iMDsoft.API.Metavision.Data.Orders.OrderingStyleEnum |
None. |
| IsUnplanned |
Only used during GET. Indicates whether the order represents a planned order or an unplanned (orphan) dose. |
boolean |
None. |
| PatternItems |
The number of pattern items (combined with the frequency information provided in the pattern item's timing) can determine whether the order is treated as a pattern order, or whether it is with pattern mode off. |
Collection of iMDsoft.API.Metavision.Data.Orders.PatternItem |
None. |
| DetectedIssues |
Detected issues - currently used for patient order allergy conflicts |
Collection of iMDsoft.API.Metavision.Data.Orders.DetectedIssue |
None. |
| LogEntries |
Only used for Get Orders, toggled via URI parameter "includeOrderLog". If enabled, returns the order and all actions performed on it row by row along with the ordering and issuing users, time, old value, and new value. Not used for drafts or posting orders. |
Collection of iMDsoft.API.Metavision.Data.Orders.LogEntry |
None. |
| EncounterInfo |
Patient identifier |
iMDsoft.API.Metavision.Data.Orders.EncounterInfo |
None. |
| OrderId |
MetaVision order ID. |
string |
None. |
| OrderGUID |
If orderID is GUID, will be used as the order GUID when posting to the Shopping Cart. |
string |
None. |
| Route |
Route, e.g. "IV" or "Per Os". |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Location |
Location e.g. "left arm". |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| PRN |
PRN details. |
iMDsoft.API.Metavision.Data.Orders.PRNElements |
None. |
| OrderedBy |
When getting orders, the user on whose behalf the order was created. Not used for drafts or posting orders. |
string |
None. |
| IssuedBy |
When getting orders, the user who entered the order. Not used for drafts or posting orders. |
string |
None. |
| Comment |
Additional instructions/comments for the order |
string |
None. |
| OrderSummary |
Human readable fallback data with all the information needed to create an order in case any details were not successfully translated. |
string |
None. |
| Caption |
A caption is an alias name for the order. For example, “TPN” may describe an order that contains multiple medications combined as a single order. |
string |
None. |
| Status |
When getting orders, specifies the current state of the order. Can be one of the following: in-progress | on-hold | completed | entered-in-error | stopped. In-progress status is returned for both "pending" and "active" orders. Not used for drafts or posting orders. When posting orders, on-hold orders will be entered as held into the shopping cart. |
string |
None. |
| StatusReason |
When getting orders, reason for the current status. Can be blank. For example, "Pending re-evaluation". Always blank in MetaVision version 6.11. Completed orders and unplanned orders do not support having a reason. Not used for drafts or posting orders. |
string |
None. |
| StatusComment |
When getting orders, additional comments accompanying the status reason. For example, "Awaiting lab results before deciding whether to resume or stop the order." Always blank in MetaVision version 6.11. Completed orders and unplanned orders do not support having a reason. Not used for drafts or posting orders. |
string |
None. |
| IsSelfAdministered |
Indicates whether the order is self administered. |
boolean |
None. |
| DbTimeStamp |
SQL time stamp |
Collection of byte |
None. |
| Effective |
Represents the planned start date & time and end method of an order |
iMDsoft.API.Metavision.Data.Orders.Effective |
None. |
| LastUpdated |
The last update time of the order |
date |
None. |
| OriginalOrderData |
The original order data |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"encounterInfo": {
"mrNumber": "sample string 1",
"accountNumber": "sample string 2"
},
"orderId": "sample string 3",
"orderGUID": "sample string 4",
"route": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"location": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"prn": {
"isPRN": true,
"instruction": "sample string 2",
"maxDispensePer24h": 1,
"maxDispensePer24hUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"orderedBy": "sample string 5",
"issuedBy": "sample string 6",
"comment": "sample string 8",
"orderSummary": "sample string 9",
"caption": "sample string 10",
"status": "sample string 11",
"statusReason": "sample string 12",
"statusComment": "sample string 13",
"isSelfAdministered": true,
"dbTimeStamp": "QEA=",
"effective": {
"startDateTime": "2024-09-22T13:25:40.6687139+03:00",
"endDateTime": "2024-09-22T13:25:40.6687139+03:00",
"endNumberOfDoses": 1
},
"lastUpdated": "2024-09-22T13:25:40.6687139+03:00",
"originalOrderData": "sample string 15",
"isHomeMedication": true,
"orderingStyle": "None",
"isUnplanned": true,
"patternItems": [
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6687139+03:00",
"2024-09-22T13:25:40.6687139+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
},
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6687139+03:00",
"2024-09-22T13:25:40.6687139+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
}
],
"detectedIssues": [
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
},
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
}
],
"logEntries": [
{
"time": "2024-09-22T13:25:40.6687139+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
}
]
},
{
"time": "2024-09-22T13:25:40.6687139+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
}
]
}
]
},
{
"encounterInfo": {
"mrNumber": "sample string 1",
"accountNumber": "sample string 2"
},
"orderId": "sample string 3",
"orderGUID": "sample string 4",
"route": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"location": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"prn": {
"isPRN": true,
"instruction": "sample string 2",
"maxDispensePer24h": 1,
"maxDispensePer24hUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"orderedBy": "sample string 5",
"issuedBy": "sample string 6",
"comment": "sample string 8",
"orderSummary": "sample string 9",
"caption": "sample string 10",
"status": "sample string 11",
"statusReason": "sample string 12",
"statusComment": "sample string 13",
"isSelfAdministered": true,
"dbTimeStamp": "QEA=",
"effective": {
"startDateTime": "2024-09-22T13:25:40.6687139+03:00",
"endDateTime": "2024-09-22T13:25:40.6687139+03:00",
"endNumberOfDoses": 1
},
"lastUpdated": "2024-09-22T13:25:40.6687139+03:00",
"originalOrderData": "sample string 15",
"isHomeMedication": true,
"orderingStyle": "None",
"isUnplanned": true,
"patternItems": [
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6687139+03:00",
"2024-09-22T13:25:40.6687139+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
},
{
"orderComponents": [
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
},
{
"product": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medication": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"medicationDoseForm": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"package": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"substitution": {
"disallowed": true,
"reason": "sample string 2"
},
"componentType": "None",
"amountSimple": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
},
"concentrationRatio": {
"value": 1.0,
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"volumeUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
}
}
}
],
"timing": {
"event": [
"2024-09-22T13:25:40.6687139+03:00",
"2024-09-22T13:25:40.6687139+03:00"
],
"code": "sample string 1",
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"timeOfDay": [
"00:00:00.1234567",
"00:00:00.1234567"
]
},
"description": "sample string 2"
},
"orderTotalVolume": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"rateRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
},
"infuseOverSimple": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"value": 1.0
},
"infuseOverRange": {
"unit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"lowValue": 1.0,
"highValue": 2.0
}
}
],
"detectedIssues": [
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
},
{
"issueId": 1,
"description": "sample string 1",
"requiredMitigation": 0,
"severity": 0,
"mitigation": {
"acknowledged": true,
"coSignUser": "sample string 2",
"reason": "sample string 3"
}
}
],
"logEntries": [
{
"time": "2024-09-22T13:25:40.6687139+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
}
]
},
{
"time": "2024-09-22T13:25:40.6687139+03:00",
"action": "sample string 2",
"orderedBy": "sample string 3",
"issuedBy": "sample string 4",
"logChanges": [
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
},
{
"action": "sample string 1",
"field": "sample string 2",
"newValue": "sample string 3",
"previousValue": "sample string 4",
"time": "2024-09-22T13:25:40.6687139+03:00",
"issuedBy": "sample string 5"
}
]
}
]
}
]