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.OrphanDoseFromTemplateData| Name | 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": "cf3d9da3-61ef-4700-9526-c6c8385ffc2a",
"isHomeMedication": true,
"isSelfAdmin": true,
"startTime": "2025-07-07T08:35:55.67413+03:00",
"coSignPreparationUser": "sample string 4",
"cosignAdministrationUser": "sample string 5",
"orderedBy": "sample string 6",
"isPrepared": true,
"pumpId": 1,
"attachedForms": [
{
"formId": "e05fecb3-fe46-49f1-a613-4a8714e81d0f",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "07950074-ae55-4e21-8cdf-e43763d757d1",
"isCrossPlatform": true
},
{
"formId": "e05fecb3-fe46-49f1-a613-4a8714e81d0f",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "07950074-ae55-4e21-8cdf-e43763d757d1",
"isCrossPlatform": true
}
],
"actionTime": "2025-07-07T08:35:55.67413+03:00"
}
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
iMDsoft.API.Metavision.Data.Doses.DoseResultOfiMDsoft.API.Metavision.Data.Doses.TaskProcessDataModels.TaskProcess| Name | 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": "63f025bb-c83d-43e4-b33d-aa44f5388956",
"doseInstanceId": 5,
"orderGuid": "1836b590-be4f-4d15-90d7-5e22cf8f5f9f",
"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": "2025-07-07T08:35:55.67413+03:00",
"endTime": "2025-07-07T08:35:55.67413+03:00",
"duration": 1.0,
"durationUnit": "Min",
"effortNumberOfCareGivers": 1,
"effortDuration": 1,
"enteredTime": "2025-07-07T08:35:55.67413+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": "2025-07-07T08:35:55.67413+03:00",
"preparationStatus": "Unprepared",
"preparationUser": "sample string 21",
"preparationTime": "2025-07-07T08:35:55.67413+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": "e63e8a9b-dd20-458d-aee7-4d90a9d90666",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "6b16b87e-285f-46d3-85b5-a0c1f3a7c2c6",
"isCrossPlatform": true
},
{
"formId": "e63e8a9b-dd20-458d-aee7-4d90a9d90666",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "6b16b87e-285f-46d3-85b5-a0c1f3a7c2c6",
"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": "2025-07-07T08:35:55.67413+03:00",
"isConditional": true,
"conditionalIndication": "sample string 26",
"coSignAdministrationUser": "sample string 1",
"sections": [
{
"startTime": "2025-07-07T08:35:55.67413+03:00",
"endTime": "2025-07-07T08:35:55.67413+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": "2025-07-07T08:35:55.67413+03:00",
"endTime": "2025-07-07T08:35:55.67413+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": "60f3537a-6f8c-4b81-bf8b-6a41078d8efd",
"doseInstanceId": 1,
"templateId": 1,
"templateInstanceGuid": "f625ed3f-4886-4527-9593-1ffa0619eaef",
"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
}