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.OrphanDoseData| Name | Description | Type | Additional information |
|---|---|---|---|
| DoseForm |
Dose form of the medication being administered, for example "Tablet" or "Infusion bag". |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Route |
Route, e.g. "IV" or "Per Os". The route the dose was planned with will be returned. If the dose has no route, null will be returned. |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| Location |
Location e.g. "left arm". The location the dose was planned with will be returned. If the dose has no location, null will be returned. |
iMDsoft.API.Metavision.Data.Data.CodedElement |
None. |
| StartTime |
The start time the dose was planned with. |
date |
None. |
| CoSignAdministrationUser |
The user who co-signed the dose for administration. |
string |
None. |
| CoSignPreparationUser |
The user who co-signed the dose for preparation. |
string |
None. |
| Comments |
Comments entered for the dose. |
string |
None. |
| IsSelfAdministered |
Indicates whether the dose is self administered. |
boolean |
None. |
| IsHomeMedication |
Indicates whether the dose is given at home. |
boolean |
None. |
| HasWarning |
Indicates whether the dose has a warning. /// |
boolean |
None. |
| OrderingStyle |
Represents the ordering style in the MetaVision order. |
iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.OrderingStyleEnum |
None. |
| OrderedBy |
When getting orders, the user on whose behalf the order was created. Not used for drafts or posting orders. |
string |
None. |
| OrderComponents |
List of order components. Represents the dose details grid in the Dose Entry window in MetaVision. |
Collection of iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.ActionOrderComponent |
None. |
| IsPrepared |
Is orphan dose prepared |
boolean |
None. |
| Rate |
The drip rate at which the medication should be administered. Whether the main component is in mass or volume unit, rate will be returned (not dose). |
iMDsoft.API.Metavision.Data.Data.DripUnitNameAndValueOfSystem.Decimal |
None. |
| InfuseOver |
The duration for which the medication should be infused over. |
iMDsoft.API.Metavision.Data.Data.UnitNameAndValueOfSystem.Decimal |
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:
{
"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-11-07T02:41:05.3371867+02: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": "e0cc99eb-9d6e-4285-9692-9be11eeacef0",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "bf429837-5a58-440a-be19-14d88ac32f57",
"isCrossPlatform": true
},
{
"formId": "e0cc99eb-9d6e-4285-9692-9be11eeacef0",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "bf429837-5a58-440a-be19-14d88ac32f57",
"isCrossPlatform": true
}
],
"actionTime": "2024-11-07T02:41:05.3371867+02:00"
}
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
iMDsoft.API.Metavision.Data.Doses.DoseResultOfiMDsoft.API.Metavision.Data.Doses.Dose| Name | 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": "86683724-f975-4db8-94eb-fa72e1f4063a",
"doseInstanceId": 2,
"patientId": 3,
"orderId": 4,
"orderGuid": "23c0ebc1-b726-40e1-a5fd-5b301e225ae3",
"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-11-07T02:41:05.3371867+02:00",
"endTime": "2024-11-07T02:41:05.3371867+02:00",
"coSignAdministrationUser": "sample string 6",
"enteredByUser": "sample string 7",
"enteredTime": "2024-11-07T02:41:05.3371867+02:00",
"updateTime": "2024-11-07T02:41:05.3371867+02: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-11-07T02:41:05.3371867+02:00",
"endTime": "2024-11-07T02:41:05.3371867+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:05.3371867+02:00",
"endTime": "2024-11-07T02:41:05.3371867+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"
}
]
}
],
"attachedForms": [
{
"formId": "4b6682a3-e493-4fcf-ad26-382f358b9a02",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "65743ef2-d115-42df-832f-f4f1feb6862b",
"isCrossPlatform": true
},
{
"formId": "4b6682a3-e493-4fcf-ad26-382f358b9a02",
"formName": "sample string 2",
"isMandatory": true,
"callerId": "65743ef2-d115-42df-832f-f4f1feb6862b",
"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": "e280cd94-31bf-4f62-98f1-9458c4c86b74",
"isConditional": true,
"conditionalIndication": "sample string 21"
},
"doseId": "7c6030c7-53c6-4f94-bcf1-e2a863134219",
"doseInstanceId": 1,
"templateId": 1,
"templateInstanceGuid": "3a37105f-572e-421b-b018-a9653aa6ef6c",
"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
}