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": "880c4cd5-5b1c-4777-ad01-a1632449ec49",
"isHomeMedication": true,
"isSelfAdmin": true,
"startTime": "2025-11-03T13:08:04.4825111+02:00",
"coSignPreparationUser": "sample string 4",
"cosignAdministrationUser": "sample string 5",
"orderedBy": "sample string 6",
"isPrepared": true,
"pumpId": 1,
"attachedForms": [
{
"formId": "e2b767c3-e325-4791-a9e0-b57c51286508",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "d5076f28-0cb7-4966-9107-9b179deac529",
"isCrossPlatform": true
},
{
"formId": "e2b767c3-e325-4791-a9e0-b57c51286508",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "d5076f28-0cb7-4966-9107-9b179deac529",
"isCrossPlatform": true
}
],
"actionTime": "2025-11-03T13:08:04.4825111+02: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 |
None. |
Response Formats
application/json, text/json
Sample:
{
"doseData": {
"patientId": 3,
"id": "752f8c4a-ba85-4817-83eb-95a39f8594be",
"doseInstanceId": 5,
"orderGuid": "b265ae4d-0927-4cc7-a563-d9d48d9745f0",
"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-11-03T13:08:04.4980898+02:00",
"endTime": "2025-11-03T13:08:04.4980898+02:00",
"duration": 1.0,
"durationUnit": "Min",
"effortNumberOfCareGivers": 1,
"effortDuration": 1,
"enteredTime": "2025-11-03T13:08:04.4980898+02: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-11-03T13:08:04.4980898+02:00",
"preparationStatus": "Unprepared",
"preparationUser": "sample string 21",
"preparationTime": "2025-11-03T13:08:04.4980898+02: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": "9189d48a-7b91-42af-a98d-8ab1cc07af19",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "a0b3795e-888c-4d2f-b264-29f2da4ac331",
"isCrossPlatform": true
},
{
"formId": "9189d48a-7b91-42af-a98d-8ab1cc07af19",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "a0b3795e-888c-4d2f-b264-29f2da4ac331",
"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-11-03T13:08:04.4980898+02:00",
"isConditional": true,
"conditionalIndication": "sample string 26",
"coSignAdministrationUser": "sample string 1",
"sections": [
{
"startTime": "2025-11-03T13:08:04.4980898+02:00",
"endTime": "2025-11-03T13:08:04.4980898+02: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-11-03T13:08:04.4980898+02:00",
"endTime": "2025-11-03T13:08:04.4980898+02: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": "94267e8e-3259-4e08-b9c5-20646e107516",
"doseInstanceId": 1,
"templateId": 1,
"templateInstanceGuid": "58785adf-e0f6-48f9-9dc1-c62899e1eadf",
"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
}