GET API/V1/Patients/{patientId}/PlannedDoses
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
patientId | integer |
Required |
|
Medication | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
Product | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
PatientId | integer |
None. |
|
StartTimeBefore | date |
None. |
|
StartTimeAfter | date |
None. |
|
EndTimeBefore | date |
None. |
|
EndTimeAfter | date |
None. |
|
Status | string |
None. |
|
MedicationGroupSet | iMDsoft.API.Metavision.Data.Data.MedicationGroupSet |
None. |
|
Route | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
LastUpdateSince | date |
None. |
|
IsSelfAdministered | boolean |
None. |
|
PreparationStatus | iMDsoft.API.Metavision.Data.Doses.Enums.DosePreparationStatusEnum |
None. |
|
IsPrn | boolean |
None. |
|
OrderId | integer |
None. |
|
Sort | iMDsoft.API.Metavision.Data.Doses.Enums.DoseSearchPropertiesSortEnum |
None. |
|
Count | integer |
None. |
|
OrderGuid | globally unique identifier |
None. |
|
DbTimeStamp | string |
None. |
|
HideSections | boolean |
None. |
|
IgnoreOrderCache | boolean |
None. |
|
IncludeErrors | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of iMDsoft.API.Metavision.Data.Doses.PlannedDoseName | Description | 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. |
Response Formats
application/json, text/json
Sample:
[ { "id": "f2a65d89-eac1-41c8-af64-fa02766c419c", "doseInstanceId": 2, "patientId": 3, "orderId": 4, "orderGuid": "e2272e2b-8239-4fc8-9b95-1bdf0d4861ca", "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:46.30147+03:00", "enteredByUser": "sample string 6", "enteredTime": "2024-09-22T13:32:46.30147+03:00", "updateTime": "2024-09-22T13:32:46.30147+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:46.30147+03:00", "displayStatus": "sample string 19", "orderStatus": "sample string 20", "isPRN": true, "coSignForPreparationAction": "NotRequired", "coSignForAdministrationAction": "NotRequired", "attachedForms": [ { "formId": "77159313-f102-4d73-a640-2781d2a9c44c", "formName": "sample string 2", "isMandatory": true, "callerId": "e415cdf6-847a-4122-8409-eacf81e4fae3", "isCrossPlatform": true }, { "formId": "77159313-f102-4d73-a640-2781d2a9c44c", "formName": "sample string 2", "isMandatory": true, "callerId": "e415cdf6-847a-4122-8409-eacf81e4fae3", "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:46.30147+03:00", "orderingStyle": "None", "isConditional": true, "conditionalIndication": "sample string 23" }, { "id": "f2a65d89-eac1-41c8-af64-fa02766c419c", "doseInstanceId": 2, "patientId": 3, "orderId": 4, "orderGuid": "e2272e2b-8239-4fc8-9b95-1bdf0d4861ca", "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:46.30147+03:00", "enteredByUser": "sample string 6", "enteredTime": "2024-09-22T13:32:46.30147+03:00", "updateTime": "2024-09-22T13:32:46.30147+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:46.30147+03:00", "displayStatus": "sample string 19", "orderStatus": "sample string 20", "isPRN": true, "coSignForPreparationAction": "NotRequired", "coSignForAdministrationAction": "NotRequired", "attachedForms": [ { "formId": "77159313-f102-4d73-a640-2781d2a9c44c", "formName": "sample string 2", "isMandatory": true, "callerId": "e415cdf6-847a-4122-8409-eacf81e4fae3", "isCrossPlatform": true }, { "formId": "77159313-f102-4d73-a640-2781d2a9c44c", "formName": "sample string 2", "isMandatory": true, "callerId": "e415cdf6-847a-4122-8409-eacf81e4fae3", "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:46.30147+03:00", "orderingStyle": "None", "isConditional": true, "conditionalIndication": "sample string 23" } ]