POST API/V1/Patients/{patientId}/TasksOrders/ShoppingCart

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required

Body Parameters

Collection of iMDsoft.API.Metavision.Data.Orders.ExternalTask

Name	Description	Type	Additional information
Timing	Represents the frequency at which the task should be administered.	iMDsoft.API.Metavision.Data.Orders.Timing	None.
Task	Task	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
EffortNumberOfCareGivers	Number Of Care Givers	integer	None.
EffortDuration	Effort Duration in minutes	integer	None.
Type	Type of the data rather it is a Task or a Process	iMDsoft.API.Metavision.Data.Orders.TaskProcessType	None.
ProcessDuration	Duration of a process, represents by decimal value and a codedElement unit. If process duration is SpecifyLater then property would be NULL.	iMDsoft.API.Metavision.Data.Orders.ProcessDuration	None.
LastAdministered	DateTime of the task/process last administration instance.	date	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.
Eligibility		iMDsoft.API.Metavision.Data.Orders.Eligibility	None.
LastUpdated	The last update time of the order	date	None.
OriginalOrderData	The original order data	string	None.
ConditionalDetails	Conditional order details.	iMDsoft.API.Metavision.Data.Orders.ConditionalDetails	None.
HasWarning	Order's warning flag value	boolean	None.
TemplateId	Template Id	integer	None.
AttachedForms		Collection of iMDsoft.API.Metavision.Data.Orders.AttachedForm	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "encounterInfo": {
      "mrNumber": "sample string 1",
      "accountNumber": "sample string 2"
    },
    "orderId": "sample string 1",
    "orderGUID": "sample string 2",
    "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 3",
    "issuedBy": "sample string 4",
    "comment": "sample string 6",
    "orderSummary": "sample string 7",
    "caption": "sample string 8",
    "status": "sample string 9",
    "statusReason": "sample string 10",
    "statusComment": "sample string 11",
    "isSelfAdministered": true,
    "dbTimeStamp": "QEA=",
    "effective": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "eligibility": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "lastUpdated": "2024-11-07T02:43:47.9714746+02:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "d37b1fa6-a16a-4077-b45d-627e9c0387e4",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "fe4e5361-0f32-47be-97b6-be7ccb9dc4ea",
        "isCrossPlatform": true
      },
      {
        "formId": "d37b1fa6-a16a-4077-b45d-627e9c0387e4",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "fe4e5361-0f32-47be-97b6-be7ccb9dc4ea",
        "isCrossPlatform": true
      }
    ],
    "timing": {
      "event": [
        "2024-11-07T02:43:47.9714746+02:00",
        "2024-11-07T02:43:47.9714746+02: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"
    },
    "task": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "effortNumberOfCareGivers": 1,
    "effortDuration": 1,
    "type": "Task",
    "processDuration": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "lastAdministered": "2024-11-07T02:43:47.9714746+02:00"
  },
  {
    "encounterInfo": {
      "mrNumber": "sample string 1",
      "accountNumber": "sample string 2"
    },
    "orderId": "sample string 1",
    "orderGUID": "sample string 2",
    "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 3",
    "issuedBy": "sample string 4",
    "comment": "sample string 6",
    "orderSummary": "sample string 7",
    "caption": "sample string 8",
    "status": "sample string 9",
    "statusReason": "sample string 10",
    "statusComment": "sample string 11",
    "isSelfAdministered": true,
    "dbTimeStamp": "QEA=",
    "effective": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "eligibility": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "lastUpdated": "2024-11-07T02:43:47.9714746+02:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "d37b1fa6-a16a-4077-b45d-627e9c0387e4",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "fe4e5361-0f32-47be-97b6-be7ccb9dc4ea",
        "isCrossPlatform": true
      },
      {
        "formId": "d37b1fa6-a16a-4077-b45d-627e9c0387e4",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "fe4e5361-0f32-47be-97b6-be7ccb9dc4ea",
        "isCrossPlatform": true
      }
    ],
    "timing": {
      "event": [
        "2024-11-07T02:43:47.9714746+02:00",
        "2024-11-07T02:43:47.9714746+02: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"
    },
    "task": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "effortNumberOfCareGivers": 1,
    "effortDuration": 1,
    "type": "Task",
    "processDuration": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "lastAdministered": "2024-11-07T02:43:47.9714746+02:00"
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Orders.ExternalTask

Name	Description	Type	Additional information
Timing	Represents the frequency at which the task should be administered.	iMDsoft.API.Metavision.Data.Orders.Timing	None.
Task	Task	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
EffortNumberOfCareGivers	Number Of Care Givers	integer	None.
EffortDuration	Effort Duration in minutes	integer	None.
Type	Type of the data rather it is a Task or a Process	iMDsoft.API.Metavision.Data.Orders.TaskProcessType	None.
ProcessDuration	Duration of a process, represents by decimal value and a codedElement unit. If process duration is SpecifyLater then property would be NULL.	iMDsoft.API.Metavision.Data.Orders.ProcessDuration	None.
LastAdministered	DateTime of the task/process last administration instance.	date	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.
Eligibility		iMDsoft.API.Metavision.Data.Orders.Eligibility	None.
LastUpdated	The last update time of the order	date	None.
OriginalOrderData	The original order data	string	None.
ConditionalDetails	Conditional order details.	iMDsoft.API.Metavision.Data.Orders.ConditionalDetails	None.
HasWarning	Order's warning flag value	boolean	None.
TemplateId	Template Id	integer	None.
AttachedForms		Collection of iMDsoft.API.Metavision.Data.Orders.AttachedForm	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "encounterInfo": {
      "mrNumber": "sample string 1",
      "accountNumber": "sample string 2"
    },
    "orderId": "sample string 1",
    "orderGUID": "sample string 2",
    "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 3",
    "issuedBy": "sample string 4",
    "comment": "sample string 6",
    "orderSummary": "sample string 7",
    "caption": "sample string 8",
    "status": "sample string 9",
    "statusReason": "sample string 10",
    "statusComment": "sample string 11",
    "isSelfAdministered": true,
    "dbTimeStamp": "QEA=",
    "effective": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "eligibility": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "lastUpdated": "2024-11-07T02:43:47.9714746+02:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "065f3073-aa40-437a-87f9-b3ad02b37f54",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "3526237c-cf67-4754-80b5-cc4a0d1479c5",
        "isCrossPlatform": true
      },
      {
        "formId": "065f3073-aa40-437a-87f9-b3ad02b37f54",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "3526237c-cf67-4754-80b5-cc4a0d1479c5",
        "isCrossPlatform": true
      }
    ],
    "timing": {
      "event": [
        "2024-11-07T02:43:47.9714746+02:00",
        "2024-11-07T02:43:47.9714746+02: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"
    },
    "task": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "effortNumberOfCareGivers": 1,
    "effortDuration": 1,
    "type": "Task",
    "processDuration": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "lastAdministered": "2024-11-07T02:43:47.9714746+02:00"
  },
  {
    "encounterInfo": {
      "mrNumber": "sample string 1",
      "accountNumber": "sample string 2"
    },
    "orderId": "sample string 1",
    "orderGUID": "sample string 2",
    "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 3",
    "issuedBy": "sample string 4",
    "comment": "sample string 6",
    "orderSummary": "sample string 7",
    "caption": "sample string 8",
    "status": "sample string 9",
    "statusReason": "sample string 10",
    "statusComment": "sample string 11",
    "isSelfAdministered": true,
    "dbTimeStamp": "QEA=",
    "effective": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "eligibility": {
      "startDateTime": "2024-11-07T02:43:47.9714746+02:00",
      "endDateTime": "2024-11-07T02:43:47.9714746+02:00"
    },
    "lastUpdated": "2024-11-07T02:43:47.9714746+02:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "065f3073-aa40-437a-87f9-b3ad02b37f54",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "3526237c-cf67-4754-80b5-cc4a0d1479c5",
        "isCrossPlatform": true
      },
      {
        "formId": "065f3073-aa40-437a-87f9-b3ad02b37f54",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "3526237c-cf67-4754-80b5-cc4a0d1479c5",
        "isCrossPlatform": true
      }
    ],
    "timing": {
      "event": [
        "2024-11-07T02:43:47.9714746+02:00",
        "2024-11-07T02:43:47.9714746+02: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"
    },
    "task": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "effortNumberOfCareGivers": 1,
    "effortDuration": 1,
    "type": "Task",
    "processDuration": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "lastAdministered": "2024-11-07T02:43:47.9714746+02:00"
  }
]