GET API/V1/Patients/{patientId}/Doses/{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.DoseName | Description | Type | Additional information |
---|---|---|---|
DoseId | integer |
None. |
|
Id | globally unique identifier |
None. |
|
DoseInstanceId | integer |
None. |
|
PatientId | integer |
None. |
|
OrderId | integer |
None. |
|
OrderGuid | globally unique identifier |
None. |
|
OrderHistoryId | integer |
None. |
|
Route | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
Location | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
StartTime | date |
None. |
|
EndTime | date |
None. |
|
CoSignAdministrationUser | string |
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. |
|
IsPlanned | boolean |
None. |
|
Rate | iMDsoft.API.Metavision.Data.Doses.UnitNameAndValueExtendedOfSystem.NullableOfSystem.Decimal |
None. |
|
InfuseOver | iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal |
None. |
|
OrderComponents | Collection of iMDsoft.API.Metavision.Data.Doses.OrderComponent |
None. |
|
Sections | Collection of iMDsoft.API.Metavision.Data.Doses.Section |
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. |
|
NextPrnDoseId | globally unique identifier |
None. |
|
IsConditional | boolean |
None. |
|
ConditionalIndication | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "doseId": 1, "id": "161534fc-adfc-4991-bb6b-ae122f8ae0fb", "doseInstanceId": 2, "patientId": 3, "orderId": 4, "orderGuid": "d54f5ff5-350e-4d09-9507-ce1e5ba0c2d6", "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-09-22T13:25:36.2702452+03:00", "endTime": "2024-09-22T13:25:36.2702452+03:00", "coSignAdministrationUser": "sample string 6", "enteredByUser": "sample string 7", "enteredTime": "2024-09-22T13:25:36.2702452+03:00", "updateTime": "2024-09-22T13:25:36.2702452+03: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-09-22T13:25:36.2702452+03:00", "endTime": "2024-09-22T13:25:36.2702452+03: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-09-22T13:25:36.2702452+03:00", "endTime": "2024-09-22T13:25:36.2702452+03: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": "fd693ca9-c79d-4e75-be26-222e48429d52", "formName": "sample string 2", "isMandatory": true, "callerId": "1b17ae95-65ba-4bc0-b344-9d2e6dda08e8", "isCrossPlatform": true }, { "formId": "fd693ca9-c79d-4e75-be26-222e48429d52", "formName": "sample string 2", "isMandatory": true, "callerId": "1b17ae95-65ba-4bc0-b344-9d2e6dda08e8", "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": "3e9112af-3d27-44eb-9b72-53e3085566b6", "isConditional": true, "conditionalIndication": "sample string 21" }