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

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required
doseInstanceId		integer	Required

Body Parameters

None.

Response Information

Resource Description

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.
IsConditional	Is conditional	boolean	None.
ConditionalIndication	Conditional Indication	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "152cf3a8-af56-4589-8fce-a68d4d94f05a",
  "doseInstanceId": 2,
  "patientId": 3,
  "orderId": 4,
  "orderGuid": "256e5295-201a-4132-ac6b-4e3621332efe",
  "route": {
    "id": 1,
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "location": {
    "id": 1,
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "startTime": "2024-11-07T02:43:03.9980352+02:00",
  "enteredByUser": "sample string 6",
  "enteredTime": "2024-11-07T02:43:03.9980352+02:00",
  "updateTime": "2024-11-07T02:43:03.9980352+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": "2024-11-07T02:43:03.9980352+02:00",
  "displayStatus": "sample string 19",
  "orderStatus": "sample string 20",
  "isPRN": true,
  "coSignForPreparationAction": "NotRequired",
  "coSignForAdministrationAction": "NotRequired",
  "attachedForms": [
    {
      "formId": "37b545a5-0dfa-4969-99e4-7f30c73a43b0",
      "formName": "sample string 2",
      "isMandatory": true,
      "callerId": "f86b40cc-b990-435a-9a16-8f0b532b15ed",
      "isCrossPlatform": true
    },
    {
      "formId": "37b545a5-0dfa-4969-99e4-7f30c73a43b0",
      "formName": "sample string 2",
      "isMandatory": true,
      "callerId": "f86b40cc-b990-435a-9a16-8f0b532b15ed",
      "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-11-07T02:43:03.9980352+02:00",
  "orderingStyle": "None",
  "isConditional": true,
  "conditionalIndication": "sample string 23"
}