POST API/V1/Patients/{patientId}/AdministeredDoses/CreateOrphanDose
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
patientId | integer |
Required |
Body Parameters
iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.OrphanDoseDataName | Description | Type | Additional information |
---|---|---|---|
DoseForm | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
Route | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
Location | iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
|
StartTime | date |
None. |
|
CoSignAdministrationUser | string |
None. |
|
CoSignPreparationUser | string |
None. |
|
Comments | string |
None. |
|
IsSelfAdministered | boolean |
None. |
|
IsHomeMedication | boolean |
None. |
|
HasWarning | boolean |
None. |
|
OrderingStyle | iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.OrderingStyleEnum |
None. |
|
OrderedBy | string |
None. |
|
OrderComponents | Collection of iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.ActionOrderComponent |
None. |
|
IsPrepared | boolean |
None. |
|
Rate | iMDsoft.API.Metavision.Data.Data.DripUnitNameAndValueOfSystem.Decimal |
None. |
|
InfuseOver | iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal |
None. |
|
AttachedForms | Collection of iMDsoft.API.Metavision.Data.Doses.AttachedForm |
None. |
|
ActionTime | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "doseForm": { "id": 1, "code": "sample string 1", "description": "sample string 2" }, "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:13:04.818878+03:00", "coSignAdministrationUser": "sample string 1", "coSignPreparationUser": "sample string 2", "comments": "sample string 3", "isSelfAdministered": true, "isHomeMedication": true, "hasWarning": true, "orderingStyle": "None", "orderedBy": "sample string 7", "orderComponents": [ { "medication": { "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 } }, "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" }, "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 } }, "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" } ], "isPrepared": 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 }, "attachedForms": [ { "formId": "74f5a548-dce1-419c-af2f-663b50b434b6", "formName": "sample string 2", "isMandatory": true, "callerId": "2897adac-d61f-40ee-9cf4-6caf1824d5f4", "isCrossPlatform": true }, { "formId": "74f5a548-dce1-419c-af2f-663b50b434b6", "formName": "sample string 2", "isMandatory": true, "callerId": "2897adac-d61f-40ee-9cf4-6caf1824d5f4", "isCrossPlatform": true } ], "actionTime": "2024-09-22T13:13:04.818878+03:00" }
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
iMDsoft.API.Metavision.Data.Doses.DoseResultOfiMDsoft.API.Metavision.Data.Doses.DoseName | Description | Type | Additional information |
---|---|---|---|
DoseData | iMDsoft.API.Metavision.Data.Doses.Dose |
None. |
|
DoseId | globally unique identifier |
None. |
|
DoseInstanceId | integer |
None. |
|
TemplateId | integer |
None. |
|
TemplateInstanceGuid | globally unique identifier |
None. |
|
ValidationErrors | Collection of iMDsoft.API.Metavision.Data.Doses.ValidationError |
None. |
|
DetectedIssues | Collection of iMDsoft.API.Metavision.Data.Doses.DetectedIssue |
None. |
|
IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "doseData": { "doseId": 1, "id": "b9f347c2-ff6a-4013-8b58-141960fb2be6", "doseInstanceId": 2, "patientId": 3, "orderId": 4, "orderGuid": "a1126359-dea1-4f3a-b459-5ffe93023890", "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:13:04.818878+03:00", "endTime": "2024-09-22T13:13:04.8345607+03:00", "coSignAdministrationUser": "sample string 6", "enteredByUser": "sample string 7", "enteredTime": "2024-09-22T13:13:04.8345607+03:00", "updateTime": "2024-09-22T13:13:04.8345607+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:13:04.8345607+03:00", "endTime": "2024-09-22T13:13:04.8345607+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:13:04.8345607+03:00", "endTime": "2024-09-22T13:13:04.8345607+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": "b75337c5-1307-4173-bd0d-0bc6d5818db9", "formName": "sample string 2", "isMandatory": true, "callerId": "73e4f7bd-89fd-49df-80d9-fdb32af608ee", "isCrossPlatform": true }, { "formId": "b75337c5-1307-4173-bd0d-0bc6d5818db9", "formName": "sample string 2", "isMandatory": true, "callerId": "73e4f7bd-89fd-49df-80d9-fdb32af608ee", "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": "ff598442-efb1-4ab9-b6fa-abdbc69c1cd1", "isConditional": true, "conditionalIndication": "sample string 21" }, "doseId": "7ad20cca-ec9d-4cf3-a9c2-7a0e4e95ca2a", "doseInstanceId": 1, "templateId": 1, "templateInstanceGuid": "f4ec9b7f-cb5f-41d5-b517-d0839814895e", "validationErrors": [ { "errorCode": 0, "description": "sample string 1" }, { "errorCode": 0, "description": "sample string 1" } ], "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" } } ], "isSuccess": true }