GET API/V1/Patients/{patientId}/AdministeredDoses/{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.Dose| Name | Description | Type | Additional information |
|---|---|---|---|
| DoseId |
Depreacted but in use in lower versions of the hooks |
integer |
None. |
| 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. |
| OrderHistoryId |
MetaVision order ID of the previous order version. If no order actions were done on the orders, then OrderHistoryId = null |
integer |
None. |
| Route |
Route, e.g. "IV" or "Per Os". The route the dose was validated 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 validated 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 validated with. |
date |
None. |
| EndTime |
When there is no rate, end time = start time. When ordering style = set rate only, end time = null. For initiated doses, end time = null. In all other cases, the end time is simply the dose end time. The dose end time is updated after dose actions, for example, after pause/stop, the dose end time = paused / stopped time. This statement is also true for Set rate only doses. |
date |
None. |
| CoSignAdministrationUser |
The user who co-signed the dose for administration (=validation). |
string |
None. |
| EnteredByUser |
The user who performed the latest action, limited to these actions: Validated | initiated | mark not administered | skipped | revised. |
string |
None. |
| EnteredTime |
Latest action time (the time the action was performed) limited to the following actions: Validated | initiated | mark not administered | skipped | revised. |
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: validated | initiated | revised. 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 validated 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. Can be one of the following (status name taken from FHIR, MV status name in parenthesis): in-progress-running(validated but not finished) | not-done-skipped(skipped) | on-hold(paused) | completed(finished) | stopped(stopped) | in-progress-initiated(Initiated) | not-done-not-administered(marked not administered). By default, if the request does not contain a status query string, then the doses that will be returned will be doses in status= in-progress-running | on-hold | completed | stopped | in-progress-initiated. Doses in status entered-in-error(marked as error) are not supported. |
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. |
| IsPlanned |
Indicates whether the dose is planne or an orphan dose. |
boolean |
None. |
| Rate |
The total drip rate at which the medication should be administered. |
iMDsoft.API.Metavision.Data.Doses.UnitNameAndValueExtendedOfSystem.NullableOfSystem.Decimal |
None. |
| InfuseOver |
The total duration for which the medication should be infused over. |
iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal |
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. |
| Sections |
Represents the dose sections information. For example, a dose that runs at 60 ml/h and the user changes its rate to 80 ml/h will have two sections, each section with a different rate. |
Collection of iMDsoft.API.Metavision.Data.Doses.Section |
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. |
| NextPrnDoseId |
Next Prn Dose Id |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{
"doseId": 1,
"id": "63f30d62-1145-496a-9674-b28bc6dada32",
"doseInstanceId": 2,
"patientId": 3,
"orderId": 4,
"orderGuid": "8faf3854-3f02-4cac-a511-9dce29f2d8a0",
"orderHistoryId": 1,
"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-11T16:44:00.7388548+02:00",
"endTime": "2024-11-11T16:44:00.7388548+02:00",
"coSignAdministrationUser": "sample string 6",
"enteredByUser": "sample string 7",
"enteredTime": "2024-11-11T16:44:00.7388548+02:00",
"updateTime": "2024-11-11T16:44:00.7388548+02:00",
"orderedByUser": "sample string 10",
"coSignPreparationUser": "sample string 11",
"dosingWeightType": "sample string 12",
"weight": 1.0,
"weightUnit": {
"id": 1,
"code": "sample string 1",
"description": "sample string 2"
},
"status": "sample string 13",
"statusReasonId": 1,
"statusReason": "sample string 14",
"statusReasonComments": "sample string 15",
"hasWarning": true,
"comments": "sample string 17",
"isSelfAdministered": true,
"isPlanned": true,
"rate": {
"isVariable": true,
"unit": {
"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
},
"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"
}
],
"sections": [
{
"startTime": "2024-11-11T16:44:00.7388548+02:00",
"endTime": "2024-11-11T16:44:00.7388548+02:00",
"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
},
"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"
}
]
},
{
"startTime": "2024-11-11T16:44:00.7388548+02:00",
"endTime": "2024-11-11T16:44:00.7388548+02:00",
"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
},
"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"
}
]
}
],
"attachedForms": [
{
"formId": "146ad5fb-5aba-401a-9a52-5061a6cb8531",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "16896c5a-c083-4d7c-9ed1-8d18d4cb3db8",
"isCrossPlatform": true
},
{
"formId": "146ad5fb-5aba-401a-9a52-5061a6cb8531",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "16896c5a-c083-4d7c-9ed1-8d18d4cb3db8",
"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"
}
}
],
"nextPrnDoseId": "062a5c4e-c562-4159-be06-acc742c3a7cb"
}