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	Type	Additional information
Timing	iMDsoft.API.Metavision.Data.Orders.Timing	None.
Task	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
EffortNumberOfCareGivers	integer	None.
EffortDuration	integer	None.
Type	iMDsoft.API.Metavision.Data.Orders.TaskProcessType	None.
ProcessDuration	iMDsoft.API.Metavision.Data.Orders.ProcessDuration	None.
LastAdministered	date	None.
EncounterInfo	iMDsoft.API.Metavision.Data.Orders.EncounterInfo	None.
OrderId	string	None.
OrderGUID	string	None.
Route	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Location	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
PRN	iMDsoft.API.Metavision.Data.Orders.PRNElements	None.
OrderedBy	string	None.
IssuedBy	string	None.
Comment	string	None.
OrderSummary	string	None.
Caption	string	None.
Status	string	None.
StatusReason	string	None.
StatusComment	string	None.
IsSelfAdministered	boolean	None.
DbTimeStamp	Collection of byte	None.
Effective	iMDsoft.API.Metavision.Data.Orders.Effective	None.
Eligibility	iMDsoft.API.Metavision.Data.Orders.Eligibility	None.
LastUpdated	date	None.
OriginalOrderData	string	None.
ConditionalDetails	iMDsoft.API.Metavision.Data.Orders.ConditionalDetails	None.
HasWarning	boolean	None.
TemplateId	integer	None.
AttachedForms	Collection of iMDsoft.API.Metavision.Data.Orders.AttachedForm	None.
LastAction	string	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-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "eligibility": {
      "startDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "lastUpdated": "2024-09-22T13:17:09.6282474+03:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "00f0aa9c-5e72-4962-ad9f-8fd55c218509",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "14f9f05c-4648-4cd3-b9e9-a8141755c324",
        "isCrossPlatform": true
      },
      {
        "formId": "00f0aa9c-5e72-4962-ad9f-8fd55c218509",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "14f9f05c-4648-4cd3-b9e9-a8141755c324",
        "isCrossPlatform": true
      }
    ],
    "lastAction": "sample string 15",
    "timing": {
      "event": [
        "2024-09-22T13:17:09.6282474+03:00",
        "2024-09-22T13:17:09.6282474+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"
    },
    "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-09-22T13:17:09.6282474+03: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-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "eligibility": {
      "startDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "lastUpdated": "2024-09-22T13:17:09.6282474+03:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "00f0aa9c-5e72-4962-ad9f-8fd55c218509",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "14f9f05c-4648-4cd3-b9e9-a8141755c324",
        "isCrossPlatform": true
      },
      {
        "formId": "00f0aa9c-5e72-4962-ad9f-8fd55c218509",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "14f9f05c-4648-4cd3-b9e9-a8141755c324",
        "isCrossPlatform": true
      }
    ],
    "lastAction": "sample string 15",
    "timing": {
      "event": [
        "2024-09-22T13:17:09.6282474+03:00",
        "2024-09-22T13:17:09.6282474+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"
    },
    "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-09-22T13:17:09.6282474+03: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	Type	Additional information
Timing	iMDsoft.API.Metavision.Data.Orders.Timing	None.
Task	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
EffortNumberOfCareGivers	integer	None.
EffortDuration	integer	None.
Type	iMDsoft.API.Metavision.Data.Orders.TaskProcessType	None.
ProcessDuration	iMDsoft.API.Metavision.Data.Orders.ProcessDuration	None.
LastAdministered	date	None.
EncounterInfo	iMDsoft.API.Metavision.Data.Orders.EncounterInfo	None.
OrderId	string	None.
OrderGUID	string	None.
Route	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Location	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
PRN	iMDsoft.API.Metavision.Data.Orders.PRNElements	None.
OrderedBy	string	None.
IssuedBy	string	None.
Comment	string	None.
OrderSummary	string	None.
Caption	string	None.
Status	string	None.
StatusReason	string	None.
StatusComment	string	None.
IsSelfAdministered	boolean	None.
DbTimeStamp	Collection of byte	None.
Effective	iMDsoft.API.Metavision.Data.Orders.Effective	None.
Eligibility	iMDsoft.API.Metavision.Data.Orders.Eligibility	None.
LastUpdated	date	None.
OriginalOrderData	string	None.
ConditionalDetails	iMDsoft.API.Metavision.Data.Orders.ConditionalDetails	None.
HasWarning	boolean	None.
TemplateId	integer	None.
AttachedForms	Collection of iMDsoft.API.Metavision.Data.Orders.AttachedForm	None.
LastAction	string	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-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "eligibility": {
      "startDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "lastUpdated": "2024-09-22T13:17:09.6282474+03:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "298f4a12-e657-4207-a1df-2a2d68515630",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "539a5b29-f5e4-4c5b-ad4b-ff9b7a3696ca",
        "isCrossPlatform": true
      },
      {
        "formId": "298f4a12-e657-4207-a1df-2a2d68515630",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "539a5b29-f5e4-4c5b-ad4b-ff9b7a3696ca",
        "isCrossPlatform": true
      }
    ],
    "lastAction": "sample string 15",
    "timing": {
      "event": [
        "2024-09-22T13:17:09.6282474+03:00",
        "2024-09-22T13:17:09.6282474+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"
    },
    "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-09-22T13:17:09.6282474+03: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-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endNumberOfDoses": 1,
      "endNumberOfDosesEndTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "eligibility": {
      "startDateTime": "2024-09-22T13:17:09.6282474+03:00",
      "endDateTime": "2024-09-22T13:17:09.6282474+03:00"
    },
    "lastUpdated": "2024-09-22T13:17:09.6282474+03:00",
    "originalOrderData": "sample string 13",
    "conditionalDetails": {
      "isConditional": true,
      "indication": "sample string 2"
    },
    "hasWarning": true,
    "templateId": 1,
    "attachedForms": [
      {
        "formId": "298f4a12-e657-4207-a1df-2a2d68515630",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "539a5b29-f5e4-4c5b-ad4b-ff9b7a3696ca",
        "isCrossPlatform": true
      },
      {
        "formId": "298f4a12-e657-4207-a1df-2a2d68515630",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "539a5b29-f5e4-4c5b-ad4b-ff9b7a3696ca",
        "isCrossPlatform": true
      }
    ],
    "lastAction": "sample string 15",
    "timing": {
      "event": [
        "2024-09-22T13:17:09.6282474+03:00",
        "2024-09-22T13:17:09.6282474+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"
    },
    "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-09-22T13:17:09.6282474+03:00"
  }
]