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": "729a1bbd-fbbe-41e5-a144-44ddad718b0b",
"isHomeMedication": true,
"isSelfAdmin": true,
"startTime": "2024-11-07T02:41:28.0603499+02:00",
"coSignPreparationUser": "sample string 4",
"cosignAdministrationUser": "sample string 5",
"orderedBy": "sample string 6",
"isPrepared": true,
"pumpId": 1,
"attachedForms": [
{
"formId": "3f591c45-4c64-4f53-b11f-a759cc1dceb6",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "0ee4f381-90d6-4804-8298-73110872936a",
"isCrossPlatform": true
},
{
"formId": "3f591c45-4c64-4f53-b11f-a759cc1dceb6",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "0ee4f381-90d6-4804-8298-73110872936a",
"isCrossPlatform": true
}
],
"actionTime": "2024-11-07T02:41:28.0603499+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 | 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": "c194ea03-10b7-4048-9526-ea6599c9f49e",
"doseInstanceId": 5,
"orderGuid": "fc64689b-815c-4b12-b9bb-37a2d657ca78",
"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-11-07T02:41:28.0603499+02:00",
"endTime": "2024-11-07T02:41:28.0603499+02:00",
"duration": 1.0,
"durationUnit": "Min",
"effortNumberOfCareGivers": 1,
"effortDuration": 1,
"enteredTime": "2024-11-07T02:41:28.0603499+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": "2024-11-07T02:41:28.0603499+02:00",
"preparationStatus": "Unprepared",
"preparationUser": "sample string 21",
"preparationTime": "2024-11-07T02:41:28.0603499+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": "2ca57977-8b3e-4fb7-9373-09e6de30a31d",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "cb05e514-846f-4fdb-bf92-11fbaa03511c",
"isCrossPlatform": true
},
{
"formId": "2ca57977-8b3e-4fb7-9373-09e6de30a31d",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "cb05e514-846f-4fdb-bf92-11fbaa03511c",
"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-11-07T02:41:28.0603499+02:00",
"isConditional": true,
"conditionalIndication": "sample string 26",
"coSignAdministrationUser": "sample string 1",
"sections": [
{
"startTime": "2024-11-07T02:41:28.0603499+02:00",
"endTime": "2024-11-07T02:41:28.0603499+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": "2024-11-07T02:41:28.0603499+02:00",
"endTime": "2024-11-07T02:41:28.0603499+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": "92d8ec01-0312-4ab0-afbb-ee73699c0735",
"doseInstanceId": 1,
"templateId": 1,
"templateInstanceGuid": "b88003a7-75f4-4d1e-a1a9-2426c5d84fed",
"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
}