POST API/V1/Patients/{patientId}/AdministeredTasksProcesses/CreateOrphanDoseFromTemplate
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
patientId | integer |
Required |
Body Parameters
iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.OrphanDoseFromTemplateDataName | Description | Type | Additional information |
---|---|---|---|
TemplateId |
Orphan Template Id |
integer |
None. |
TemplateInstanceGuid |
Template Instance Guid |
globally unique identifier |
None. |
IsHomeMedication |
Is orphan dose HomeMedication |
boolean |
None. |
IsSelfAdmin |
Is orphan dose self administration |
boolean |
None. |
StartTime |
Start time of the orphan dose |
date |
None. |
CoSignPreparationUser |
CoSign user for preparation |
string |
None. |
CosignAdministrationUser |
CoSign user for administration |
string |
None. |
OrderedBy |
order by user |
string |
None. |
IsPrepared |
Is orphan dose prepared |
boolean |
None. |
PumpId |
Pump id to associste to the dose |
integer |
None. |
AttachedForms |
Attached Forms |
Collection of iMDsoft.API.Metavision.Data.Doses.AttachedForm |
None. |
ActionTime |
Action time. in offline case we also support the former report not in the future. |
date |
None. |
Request Formats
application/json, text/json
Sample:
{ "templateId": 1, "templateInstanceGuid": "bc0cf05e-088a-429c-9a5a-985d3b058889", "isHomeMedication": true, "isSelfAdmin": true, "startTime": "2024-09-22T13:21:03.2379385+03:00", "coSignPreparationUser": "sample string 4", "cosignAdministrationUser": "sample string 5", "orderedBy": "sample string 6", "isPrepared": true, "pumpId": 1, "attachedForms": [ { "formId": "68bc4b64-e43f-49f4-8bfc-52f2b2be7d80", "formName": "sample string 2", "isMandatory": true, "callerId": "a35ac2af-ddb8-4bae-9f0e-024a4de19096", "isCrossPlatform": true }, { "formId": "68bc4b64-e43f-49f4-8bfc-52f2b2be7d80", "formName": "sample string 2", "isMandatory": true, "callerId": "a35ac2af-ddb8-4bae-9f0e-024a4de19096", "isCrossPlatform": true } ], "actionTime": "2024-09-22T13:21:03.2379385+03:00" }
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
iMDsoft.API.Metavision.Data.Doses.DoseResultOfiMDsoft.API.Metavision.Data.Doses.TaskProcessDataModels.TaskProcessName | Description | Type | Additional information |
---|---|---|---|
DoseData | iMDsoft.API.Metavision.Data.Doses.TaskProcessDataModels.TaskProcess |
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": { "patientId": 3, "id": "4be6e79c-83dc-4e04-978a-6d6c26801819", "doseInstanceId": 5, "orderGuid": "b534b18e-56c9-476f-9f52-e51eec21333b", "orderId": 7, "type": "sample string 8", "key": { "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" }, "isPRN": true, "startTime": "2024-09-22T13:21:03.2379385+03:00", "endTime": "2024-09-22T13:21:03.2379385+03:00", "duration": 1.0, "durationUnit": "Min", "effortNumberOfCareGivers": 1, "effortDuration": 1, "enteredTime": "2024-09-22T13:21:03.2379385+03:00", "enteredByUser": "sample string 11", "orderedByUser": "sample string 12", "coSignPreparationUser": "sample string 13", "status": "sample string 14", "statusReasonId": 1, "statusReason": "sample string 15", "statusReasonComments": "sample string 16", "hasWarning": true, "comments": "sample string 18", "isSelfAdministered": true, "updateTime": "2024-09-22T13:21:03.2379385+03:00", "preparationStatus": "Unprepared", "preparationUser": "sample string 21", "preparationTime": "2024-09-22T13:21:03.2379385+03:00", "displayStatus": "sample string 22", "orderStatus": "sample string 23", "coSignForPreparationAction": "NotRequired", "coSignForAdministrationAction": "NotRequired", "dosingWeightType": "sample string 24", "weight": 1.0, "weightUnit": { "id": 1, "code": "sample string 1", "description": "sample string 2" }, "attachedForms": [ { "formId": "6c5966b6-f5be-46b9-9283-ce0889941623", "formName": "sample string 2", "isMandatory": true, "callerId": "2a59dd7b-0efd-4687-9cd1-2879d0637f17", "isCrossPlatform": true }, { "formId": "6c5966b6-f5be-46b9-9283-ce0889941623", "formName": "sample string 2", "isMandatory": true, "callerId": "2a59dd7b-0efd-4687-9cd1-2879d0637f17", "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:21:03.2379385+03:00", "coSignAdministrationUser": "sample string 1", "sections": [ { "startTime": "2024-09-22T13:21:03.2379385+03:00", "endTime": "2024-09-22T13:21:03.2379385+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:21:03.2379385+03:00", "endTime": "2024-09-22T13:21:03.2379385+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" } ] } ], "jsonFhirMedicalDevice": "sample string 2" }, "doseId": "695733d1-1c78-4c0a-abf7-632de7ee5f67", "doseInstanceId": 1, "templateId": 1, "templateInstanceGuid": "31814763-2889-49c1-9407-c437110d30b5", "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 }