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

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

iMDsoft.API.Metavision.Data.Doses.PlannedDose

Name	Type	Additional information
Id	globally unique identifier	None.
DoseInstanceId	integer	None.
PatientId	integer	None.
OrderId	integer	None.
OrderGuid	globally unique identifier	None.
Route	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Location	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
StartTime	date	None.
EnteredByUser	string	None.
EnteredTime	date	None.
UpdateTime	date	None.
OrderedByUser	string	None.
CoSignPreparationUser	string	None.
DosingWeightType	string	None.
Weight	decimal number	None.
WeightUnit	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Status	string	None.
StatusReasonId	integer	None.
StatusReason	string	None.
StatusReasonComments	string	None.
HasWarning	boolean	None.
Comments	string	None.
IsSelfAdministered	boolean	None.
Rate	iMDsoft.API.Metavision.Data.Data.DripUnitNameAndValueOfSystem.Decimal	None.
InfuseOver	iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal	None.
DispenseStatus	iMDsoft.API.Metavision.Data.Doses.Enums.DispenseStatusEnum	None.
OrderComponents	Collection of iMDsoft.API.Metavision.Data.Doses.OrderComponent	None.
DosePreparationStatus	iMDsoft.API.Metavision.Data.Doses.Enums.DosePreparationStatusEnum	None.
DosePreparationUser	string	None.
DosePreparationTime	date	None.
DisplayStatus	string	None.
OrderStatus	string	None.
IsPRN	boolean	None.
CoSignForPreparationAction	iMDsoft.API.Metavision.Data.Doses.Enums.CoSignEnum	None.
CoSignForAdministrationAction	iMDsoft.API.Metavision.Data.Doses.Enums.CoSignEnum	None.
AttachedForms	Collection of iMDsoft.API.Metavision.Data.Doses.AttachedForm	None.
DbTimeStamp	Collection of byte	None.
DetectedIssues	Collection of iMDsoft.API.Metavision.Data.Doses.DetectedIssue	None.
ActionTime	date	None.
OrderingStyle	iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.OrderingStyleEnum	None.
IsConditional	boolean	None.
ConditionalIndication	string	None.
BarcodeText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "bf9c7df0-ebb7-40b3-bd4a-297e8dcc67b4",
  "doseInstanceId": 2,
  "patientId": 3,
  "orderId": 4,
  "orderGuid": "fa524bc7-52ef-4d6b-91fd-9a8b31301bf0",
  "route": {
    "id": 1,
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "location": {
    "id": 1,
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "startTime": "2026-03-22T00:13:12.3220146+02:00",
  "enteredByUser": "sample string 6",
  "enteredTime": "2026-03-22T00:13:12.3220146+02:00",
  "updateTime": "2026-03-22T00:13:12.3220146+02: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": "2026-03-22T00:13:12.3220146+02:00",
  "displayStatus": "sample string 19",
  "orderStatus": "sample string 20",
  "isPRN": true,
  "coSignForPreparationAction": "NotRequired",
  "coSignForAdministrationAction": "NotRequired",
  "attachedForms": [
    {
      "formId": "832b395e-10dc-4f22-8279-2ae8b9148d44",
      "formName": "sample string 2",
      "isMandatory": true,
      "callerId": "b900299d-357c-45bd-b6b5-72be942dae25",
      "isCrossPlatform": true,
      "hasSession": true
    },
    {
      "formId": "832b395e-10dc-4f22-8279-2ae8b9148d44",
      "formName": "sample string 2",
      "isMandatory": true,
      "callerId": "b900299d-357c-45bd-b6b5-72be942dae25",
      "isCrossPlatform": true,
      "hasSession": 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": "2026-03-22T00:13:12.3220146+02:00",
  "orderingStyle": "None",
  "isConditional": true,
  "conditionalIndication": "sample string 23",
  "barcodeText": "sample string 24"
}