GET API/V1/Patients/{patientId}/PlannedDoses

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required
Medication	Medication.Id: returns all doses for the selected patient, in which their main component id or one of their addtives ids is equal to the specified medication id. Medication.Code: returns all doses for the selected patient, in which their main component code or one of their addtives codes contains the specified medication code.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Product	Product.Id: returns all doses for the selected patient, in which their main component products or one of their addtives product ids is equal to the specified product id. Product.Code: returns all doses for the selected patient, in which their main component products or one of their addtives codes contains the specified product code.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
PatientId	Returns all doses for the selected patient.	integer	None.
StartTimeBefore	Returns all doses for the selected patient, with a start time earlier than or equal to the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z	date	None.
StartTimeAfter	Returns all doses for the selected patient, with a start time later than or equal to the specified time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z	date	None.
EndTimeBefore	Returns all doses for the selected patient, with an end time earlier than or equal to the specified time. Initiated doses will not be returned. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
EndTimeAfter	Returns all doses for the selected patient, with an end time later than or equal to the specified time. Initiated doses will be returned. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
Status	Returns all doses for the selected patient, with status equal to any of the following: in-progress-running \| not-done-skipped \| on-hold \| completed \| stopped \| in-progress-initiated \| not-done-not-administered. (entered-in-error status is not supported). If this field is not used, then the doses that will be returned by default will be doses in status= in-progress-running \| on-hold \| completed \| stopped \| in-progress-initiated. Can filter by multiple statuses, each separated by a comma.	string	None.
MedicationGroupSet	Returns all doses for the selected patient, filtered by the main orderable medication which fits within the assigned medication group set's medication group. Enter with the format MedicationGroupSet.Name={SetName}&MedicationGroupSet.Group={GroupName} Only customized medication group sets can be used - "Not assigned" and "Partial Data Products" cannot be used. It is possible to get only a single medication group. The query should contain both the medication group set and the medication group, otherwise if both are not provided the result will be empty.	iMDsoft.API.Metavision.Data.Data.MedicationGroupSet	None.
Route	Route.Id: returns all doses with route id equal to the specified route id. Route.Code: returns all doses with route code which contains the specified route code.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
LastUpdateSince	Returns all doses which were last updated on or after the specified date & time. The value is an RFC 3339 formatted date-time value(1970-01-01T00:00:00Z).	date	None.
IsSelfAdministered	Returns all self administered or not self administered doses.	boolean	None.
PreparationStatus	Dose preparation status	iMDsoft.API.Metavision.Data.Doses.Enums.DosePreparationStatusEnum	None.
IsPrn	Return the prn doses acording to the flag.	boolean	None.
OrderId	Returns all doses for the selected patient with this order id.	integer	None.
Sort	Returns all doses sort according to sort parameter.	iMDsoft.API.Metavision.Data.Doses.Enums.DoseSearchPropertiesSortEnum	None.
Count	Returns number of doses.	integer	None.
OrderGuid	Returns all doses for the selected patient with this order guid.	globally unique identifier	None.
DbTimeStamp	Sql time stamp	string	None.
HideSections	Hide sections	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Doses.PlannedDose

Name	Description	Type	Additional information
Id	The dose Guid. This Guid is the same across multiple dose instance id's	globally unique identifier	None.
DoseInstanceId	Unique dose instance ID in MetaVision.	integer	None.
PatientId	Unique patient ID in MetaVision. Can be obtained via Get Patient.	integer	None.
OrderId	MetaVision order ID.	integer	None.
OrderGuid	Represents the order guid.	globally unique identifier	None.
Route	Route, e.g. "IV" or "Per Os". The route the dose was planned with will be returned. If the dose has no route, null will be returned.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Location	Location e.g. "left arm". The location the dose was planned with will be returned. If the dose has no location, null will be returned.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
StartTime	The start time the dose was planned with.	date	None.
EnteredByUser	The user who performed the latest action, limited to these actions: create \| modify.	string	None.
EnteredTime	Latest action time (the time the action was performed) limited to the following actions: create \| modify.	date	None.
UpdateTime	Latest action time (the time the action was performed).	date	None.
OrderedByUser	The user on whose behalf the action was perfomed, limited to the following actions: create \| modify. In the case of mark not administered/skipped, or in the case that there was no OrderedByUser, then OrderedByUser = EnteredByUser.	string	None.
CoSignPreparationUser	The user who co-signed the dose for preparation.	string	None.
DosingWeightType	Can be one of the following: adjusted-body-weight \| admission-weight \| dry-weight \| lean-body-weight \| ideal-weight \| birth-weight \| wet-weight.	string	None.
Weight	The patient weight that the dose was planned with.	decimal number	None.
WeightUnit	The weight parameter unit as customized at the database level.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Status	Specifies the current state of the dose.	string	None.
StatusReasonId	Reason id for the current status. Relevant only to skipped \| undo skipped \| mark not administered. (Mark as error is not supported). Refers to the last status of dose. in other case it should be null.	integer	None.
StatusReason	Reason for the current status. Relevant only to skipped \| undo skipped \| mark not administered. (Mark as error is not supported). Refers to the last status of dose.	string	None.
StatusReasonComments	Additional comments accompanying the status reason.	string	None.
HasWarning	Indicates whether the dose has a warning.	boolean	None.
Comments	Comments entered for the dose.	string	None.
IsSelfAdministered	Indicates whether the dose is self administered.	boolean	None.
Rate	The drip rate at which the medication should be administered. Whether the main component is in mass or volume unit, rate will be returned (not dose).	iMDsoft.API.Metavision.Data.Data.DripUnitNameAndValueOfSystem.Decimal	None.
InfuseOver	The duration for which the medication should be infused over.	iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal	None.
DispenseStatus	Dispense Status	iMDsoft.API.Metavision.Data.Doses.Enums.DispenseStatusEnum	None.
OrderComponents	List of order components. Represents the dose details grid in the Dose Entry window in MetaVision.	Collection of iMDsoft.API.Metavision.Data.Doses.OrderComponent	None.
DosePreparationStatus	Dose preparation status	iMDsoft.API.Metavision.Data.Doses.Enums.DosePreparationStatusEnum	None.
DosePreparationUser	Dose preparation user	string	None.
DosePreparationTime	Dose preparation time	date	None.
DisplayStatus	Dose display status	string	None.
OrderStatus	Order status	string	None.
IsPRN	Is PRN	boolean	None.
CoSignForPreparationAction	CoSignForPreparation requirements for current user/role for this dose	iMDsoft.API.Metavision.Data.Doses.Enums.CoSignEnum	None.
CoSignForAdministrationAction	CoSignForAdministration requirements for current user/role for this dose	iMDsoft.API.Metavision.Data.Doses.Enums.CoSignEnum	None.
AttachedForms	Attached Forms	Collection of iMDsoft.API.Metavision.Data.Doses.AttachedForm	None.
DbTimeStamp	SQL Time stamp	Collection of byte	None.
DetectedIssues	Detected Issues	Collection of iMDsoft.API.Metavision.Data.Doses.DetectedIssue	None.
ActionTime	Action time. in offline case we also support the former report not in the future.	date	None.
OrderingStyle	Represents the ordering style in the MetaVision order.	iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.OrderingStyleEnum	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "2bff1dff-b4ca-4659-ba7c-06ce76a07fad",
    "doseInstanceId": 2,
    "patientId": 3,
    "orderId": 4,
    "orderGuid": "2d70d342-2244-4850-86ee-c4fb54a74d08",
    "route": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "location": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "startTime": "2024-09-22T13:32:01.714947+03:00",
    "enteredByUser": "sample string 6",
    "enteredTime": "2024-09-22T13:32:01.714947+03:00",
    "updateTime": "2024-09-22T13:32:01.714947+03:00",
    "orderedByUser": "sample string 9",
    "coSignPreparationUser": "sample string 10",
    "dosingWeightType": "sample string 11",
    "weight": 1.0,
    "weightUnit": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "status": "sample string 12",
    "statusReasonId": 1,
    "statusReason": "sample string 13",
    "statusReasonComments": "sample string 14",
    "hasWarning": true,
    "comments": "sample string 16",
    "isSelfAdministered": true,
    "rate": {
      "dripUnit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "infuseOver": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "dispenseStatus": "NotOrdered",
    "orderComponents": [
      {
        "medication": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "medicationDoseForm": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "quantityVolume": {
          "unit": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "value": 1.0
        },
        "ampouleDiluent": {
          "medication": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "product": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "volume": {
            "unit": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "value": 1.0
          }
        },
        "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"
          }
        },
        "products": [
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          },
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          }
        ],
        "componentType": "None"
      },
      {
        "medication": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "medicationDoseForm": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "quantityVolume": {
          "unit": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "value": 1.0
        },
        "ampouleDiluent": {
          "medication": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "product": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "volume": {
            "unit": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "value": 1.0
          }
        },
        "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"
          }
        },
        "products": [
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          },
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          }
        ],
        "componentType": "None"
      }
    ],
    "dosePreparationStatus": "Unprepared",
    "dosePreparationUser": "sample string 18",
    "dosePreparationTime": "2024-09-22T13:32:01.714947+03:00",
    "displayStatus": "sample string 19",
    "orderStatus": "sample string 20",
    "isPRN": true,
    "coSignForPreparationAction": "NotRequired",
    "coSignForAdministrationAction": "NotRequired",
    "attachedForms": [
      {
        "formId": "3d46b9b8-3ecc-4efa-b641-62ca80964fe1",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "e3703848-2e07-4967-85e1-6b06b47dd89d",
        "isCrossPlatform": true
      },
      {
        "formId": "3d46b9b8-3ecc-4efa-b641-62ca80964fe1",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "e3703848-2e07-4967-85e1-6b06b47dd89d",
        "isCrossPlatform": true
      }
    ],
    "dbTimeStamp": "QEA=",
    "detectedIssues": [
      {
        "issueId": "None",
        "description": "sample string 1",
        "severity": "Minor",
        "requiredMitigation": "Acknowledge",
        "mitigation": {
          "acknowledged": true,
          "coSignUser": "sample string 2",
          "reason": "sample string 3"
        }
      },
      {
        "issueId": "None",
        "description": "sample string 1",
        "severity": "Minor",
        "requiredMitigation": "Acknowledge",
        "mitigation": {
          "acknowledged": true,
          "coSignUser": "sample string 2",
          "reason": "sample string 3"
        }
      }
    ],
    "actionTime": "2024-09-22T13:32:01.714947+03:00",
    "orderingStyle": "None"
  },
  {
    "id": "2bff1dff-b4ca-4659-ba7c-06ce76a07fad",
    "doseInstanceId": 2,
    "patientId": 3,
    "orderId": 4,
    "orderGuid": "2d70d342-2244-4850-86ee-c4fb54a74d08",
    "route": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "location": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "startTime": "2024-09-22T13:32:01.714947+03:00",
    "enteredByUser": "sample string 6",
    "enteredTime": "2024-09-22T13:32:01.714947+03:00",
    "updateTime": "2024-09-22T13:32:01.714947+03:00",
    "orderedByUser": "sample string 9",
    "coSignPreparationUser": "sample string 10",
    "dosingWeightType": "sample string 11",
    "weight": 1.0,
    "weightUnit": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "status": "sample string 12",
    "statusReasonId": 1,
    "statusReason": "sample string 13",
    "statusReasonComments": "sample string 14",
    "hasWarning": true,
    "comments": "sample string 16",
    "isSelfAdministered": true,
    "rate": {
      "dripUnit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "infuseOver": {
      "unit": {
        "id": 1,
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "value": 1.0
    },
    "dispenseStatus": "NotOrdered",
    "orderComponents": [
      {
        "medication": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "medicationDoseForm": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "quantityVolume": {
          "unit": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "value": 1.0
        },
        "ampouleDiluent": {
          "medication": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "product": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "volume": {
            "unit": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "value": 1.0
          }
        },
        "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"
          }
        },
        "products": [
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          },
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          }
        ],
        "componentType": "None"
      },
      {
        "medication": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "medicationDoseForm": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "quantityVolume": {
          "unit": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "value": 1.0
        },
        "ampouleDiluent": {
          "medication": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "product": {
            "id": 1,
            "code": "sample string 1",
            "description": "sample string 2"
          },
          "volume": {
            "unit": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "value": 1.0
          }
        },
        "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"
          }
        },
        "products": [
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          },
          {
            "key": {
              "id": 1,
              "code": "sample string 1",
              "description": "sample string 2"
            },
            "quantityVolume": {
              "unit": {
                "id": 1,
                "code": "sample string 1",
                "description": "sample string 2"
              },
              "value": 1.0
            },
            "barcodeInformation": "sample string 1",
            "substitution": {
              "disallowed": true,
              "reason": "sample string 2"
            }
          }
        ],
        "componentType": "None"
      }
    ],
    "dosePreparationStatus": "Unprepared",
    "dosePreparationUser": "sample string 18",
    "dosePreparationTime": "2024-09-22T13:32:01.714947+03:00",
    "displayStatus": "sample string 19",
    "orderStatus": "sample string 20",
    "isPRN": true,
    "coSignForPreparationAction": "NotRequired",
    "coSignForAdministrationAction": "NotRequired",
    "attachedForms": [
      {
        "formId": "3d46b9b8-3ecc-4efa-b641-62ca80964fe1",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "e3703848-2e07-4967-85e1-6b06b47dd89d",
        "isCrossPlatform": true
      },
      {
        "formId": "3d46b9b8-3ecc-4efa-b641-62ca80964fe1",
        "formName": "sample string 2",
        "isMandatory": true,
        "callerId": "e3703848-2e07-4967-85e1-6b06b47dd89d",
        "isCrossPlatform": true
      }
    ],
    "dbTimeStamp": "QEA=",
    "detectedIssues": [
      {
        "issueId": "None",
        "description": "sample string 1",
        "severity": "Minor",
        "requiredMitigation": "Acknowledge",
        "mitigation": {
          "acknowledged": true,
          "coSignUser": "sample string 2",
          "reason": "sample string 3"
        }
      },
      {
        "issueId": "None",
        "description": "sample string 1",
        "severity": "Minor",
        "requiredMitigation": "Acknowledge",
        "mitigation": {
          "acknowledged": true,
          "coSignUser": "sample string 2",
          "reason": "sample string 3"
        }
      }
    ],
    "actionTime": "2024-09-22T13:32:01.714947+03:00",
    "orderingStyle": "None"
  }
]