POST API/V1/Patients/{patientId}/AdministeredTasksProcesses/MarkNotAdministered
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
patientId | integer |
Required |
Body Parameters
Collection of iMDsoft.API.Metavision.Data.Doses.DoseActionDataModels.DoseActionReasonName | Description | Type | Additional information |
---|---|---|---|
DoseId |
The dose Guid. This Guid is the same across multiple dose instance id's |
globally unique identifier |
None. |
ReasonId |
Reason id |
integer |
None. |
ReasonText |
Reason text |
string |
None. |
ReasonComments |
Reason comments |
string |
None. |
ActionTime |
Action time. in offline case we also support the former report not in the future. |
date |
None. |
DbTimeStamp |
Db time stamp used for checking dose is not stale |
Collection of byte |
None. |
Request Formats
application/json, text/json
Sample:
[ { "doseId": "e52ca35a-402f-4e4d-8d15-6691c257beaa", "reasonId": 1, "reasonText": "sample string 2", "reasonComments": "sample string 3", "actionTime": "2024-11-07T02:42:08.1577744+02:00", "dbTimeStamp": "QEA=" }, { "doseId": "e52ca35a-402f-4e4d-8d15-6691c257beaa", "reasonId": 1, "reasonText": "sample string 2", "reasonComments": "sample string 3", "actionTime": "2024-11-07T02:42:08.1577744+02:00", "dbTimeStamp": "QEA=" } ]
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of 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": "e0236174-06ef-4475-8887-0a8a410f7110", "doseInstanceId": 5, "orderGuid": "03b0b3c2-a9a2-4e01-9dd1-f423d33530cf", "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:42:08.1577744+02:00", "endTime": "2024-11-07T02:42:08.1577744+02:00", "duration": 1.0, "durationUnit": "Min", "effortNumberOfCareGivers": 1, "effortDuration": 1, "enteredTime": "2024-11-07T02:42:08.1577744+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:42:08.1577744+02:00", "preparationStatus": "Unprepared", "preparationUser": "sample string 21", "preparationTime": "2024-11-07T02:42:08.1577744+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": "8af174b1-5028-4c48-835e-ac79c92484b9", "formName": "sample string 2", "isMandatory": true, "callerId": "0a7cfdca-0a53-4cef-a158-4e69b6269972", "isCrossPlatform": true }, { "formId": "8af174b1-5028-4c48-835e-ac79c92484b9", "formName": "sample string 2", "isMandatory": true, "callerId": "0a7cfdca-0a53-4cef-a158-4e69b6269972", "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:42:08.1577744+02:00", "isConditional": true, "conditionalIndication": "sample string 26", "coSignAdministrationUser": "sample string 1", "sections": [ { "startTime": "2024-11-07T02:42:08.1577744+02:00", "endTime": "2024-11-07T02:42:08.1577744+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:42:08.1577744+02:00", "endTime": "2024-11-07T02:42:08.1577744+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": "3dc2b17b-3bc2-4ac7-a9ef-3ccf300f1c45", "doseInstanceId": 1, "templateId": 1, "templateInstanceGuid": "6f6043df-a15d-4088-90a2-841e4372656c", "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 }, { "doseData": { "patientId": 3, "id": "e0236174-06ef-4475-8887-0a8a410f7110", "doseInstanceId": 5, "orderGuid": "03b0b3c2-a9a2-4e01-9dd1-f423d33530cf", "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:42:08.1577744+02:00", "endTime": "2024-11-07T02:42:08.1577744+02:00", "duration": 1.0, "durationUnit": "Min", "effortNumberOfCareGivers": 1, "effortDuration": 1, "enteredTime": "2024-11-07T02:42:08.1577744+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:42:08.1577744+02:00", "preparationStatus": "Unprepared", "preparationUser": "sample string 21", "preparationTime": "2024-11-07T02:42:08.1577744+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": "8af174b1-5028-4c48-835e-ac79c92484b9", "formName": "sample string 2", "isMandatory": true, "callerId": "0a7cfdca-0a53-4cef-a158-4e69b6269972", "isCrossPlatform": true }, { "formId": "8af174b1-5028-4c48-835e-ac79c92484b9", "formName": "sample string 2", "isMandatory": true, "callerId": "0a7cfdca-0a53-4cef-a158-4e69b6269972", "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:42:08.1577744+02:00", "isConditional": true, "conditionalIndication": "sample string 26", "coSignAdministrationUser": "sample string 1", "sections": [ { "startTime": "2024-11-07T02:42:08.1577744+02:00", "endTime": "2024-11-07T02:42:08.1577744+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:42:08.1577744+02:00", "endTime": "2024-11-07T02:42:08.1577744+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": "3dc2b17b-3bc2-4ac7-a9ef-3ccf300f1c45", "doseInstanceId": 1, "templateId": 1, "templateInstanceGuid": "6f6043df-a15d-4088-90a2-841e4372656c", "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 } ]