GET API/V1/Patients/{patientId}/PlannedTasksProcesses/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		integer	Required
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

iMDsoft.API.Metavision.Data.Doses.TaskProcessDataModels.TaskProcess

Name	Description	Type	Additional information
Sections	Represents the process sections information. For example, a process that is paused and then resumed later will have two sections.	Collection of iMDsoft.API.Metavision.Data.Doses.Section	None.
CoSignAdministrationUser	The user who co-signed the task/process for administration (=validation).	string	None.
JsonFhirMedicalDevice	Constrains the representation of a statement about a medical device used by or implanted on the patient.	string	None.
PatientId	Unique patient ID in MetaVision. Can be obtained via Get Patient.	integer	None.
Id	The dose Guid. This Guid is the same across multiple dose instance id's	globally unique identifier	None.
DoseInstanceId	Unique dose instance ID in MetaVision.	integer	None.
OrderGuid	Represents the order guid.	globally unique identifier	None.
OrderId	MetaVision order ID.	integer	None.
Type	Either task or process	string	None.
Key	Contains the parameter id, code and description of a MetaVision task/process, for example, "Abdominal drain".	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
Route	Route, e.g. "Intralesional". The route the task/process was validated 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. "Abdomen – Left". The location the task/process was validated with will be returned. If the dose has no location, null will be returned.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
IsPRN	Is PRN	boolean	None.
StartTime	The start time the task/process was validated with.	date	None.
EndTime	For tasks (type = task), end time = start time. For initiated processes, end time = null. In all other cases, the end time is simply the process end time.	date	None.
Duration	Time of duration. If it's a task or an initiated process, then duration=null	decimal number	None.
DurationUnit	DurationUnit. If it's a task or an initiated process, then DurationUnit=null	iMDsoft.API.Metavision.Data.Doses.Enums.TimeUnitEnum	None.
EffortNumberOfCareGivers	The number of care givers required for the performance of the task (relevant only to Type = Task).	integer	None.
EffortDuration	The task duration (in minutes) required for the performance of the task (relevant only to Type = Task).	integer	None.
EnteredTime	The latest action time (the time the action was performed), limited to the following actions: Validated \| initiated \| mark not administered \| skipped \| revised.	date	None.
EnteredByUser	The user who performed the latest action, limited to the following actions: Validated \| initiated \| mark not administered \| skipped \| revised.	string	None.
OrderedByUser	The user on whose behalf the action was performed, limited to the following actions: validated \| initiated \| revised. In the case of mark not administered \| skipped, or in the case that there was not any OrderedByUser, then OrderedByUser = EnteredByUser.	string	None.
CoSignPreparationUser	The user who co-signed the task/process for preparation.	string	None.
Status	Specifies the current state of the dose. Can be one of the following (status name taken from FHIR, MV status name in parenthesis): in-progress-running(validated but not finished) \| not-done-skipped(skipped) \| on-hold(paused) \| completed(finished) \| stopped(stopped) \| in-progress-initiated(Initiated) \| not-done-not-administered(marked not administered). By default, if the request does not contain a status query string, then the doses that will be returned will be doses in status= in-progress-running \| on-hold \| completed \| stopped \| in-progress-initiated. Doses in status entered-in-error(marked as error) are not supported.	string	None.
StatusReasonId	Reason id for the current status. Relevant only to skipped \| undo skipped \| mark not administered. (Mark as error is not supported). Refers to the last status of dose. in other case it should be null.	integer	None.
StatusReason	Reason for the current status. Relevant only to: skipped \| undo skipped \| mark not administered. (Mark as error not supported). Refers to the last status of dose.	string	None.
StatusReasonComments	Additional comments accompanying status reason.	string	None.
HasWarning	Indicates whether the task/process has a warning.	boolean	None.
Comments	Comments entered for the task/process.	string	None.
IsSelfAdministered	Indicates whether the dose is self administered.	boolean	None.
UpdateTime	Latest action time (the time the action was performed).	date	None.
PreparationStatus	Preparation status	iMDsoft.API.Metavision.Data.Doses.Enums.DosePreparationStatusEnum	None.
PreparationUser	The user who performed the last prepared/unprepared action	string	None.
PreparationTime	PreparationTime	date	None.
DisplayStatus	Task/Process in status planned may have different display statuses: pending, immediate, late and expired. For all the other statuses, DisplayStatus = Status.	string	None.
OrderStatus	OrderStatus	string	None.
CoSignForPreparationAction	CoSignForPreparationAction	iMDsoft.API.Metavision.Data.Doses.Enums.CoSignEnum	None.
CoSignForAdministrationAction	CoSignForAdministrationAction	iMDsoft.API.Metavision.Data.Doses.Enums.CoSignEnum	None.
DosingWeightType	Can be one of the following: adjusted-body-weight \| admission-weight \| dry-weight \| lean-body-weight \| ideal-weight \| birth-weight \| wet-weight.	string	None.
Weight	The patient weight that the dose was validated with.	decimal number	None.
WeightUnit	The weight parameter unit as customized at the database level.	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
AttachedForms	Attached Forms	Collection of iMDsoft.API.Metavision.Data.Doses.AttachedForm	None.
DbTimeStamp	SQL Time stamp	Collection of byte	None.
DetectedIssues	Detected Issues	Collection of iMDsoft.API.Metavision.Data.Doses.DetectedIssue	None.
ActionTime	Action time. in offline case we also support the former report not in the future.	date	None.
IsConditional	Is conditional	boolean	None.
ConditionalIndication	Conditional Indication	string	None.

Response Formats

application/json, text/json

Sample:

{
  "patientId": 3,
  "id": "5db9b691-1438-4041-89e0-92e1a2014e78",
  "doseInstanceId": 5,
  "orderGuid": "9f954df3-be12-4525-b4c5-d746bac4c4be",
  "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:00.8696317+02:00",
  "endTime": "2024-11-07T02:41:00.8696317+02:00",
  "duration": 1.0,
  "durationUnit": "Min",
  "effortNumberOfCareGivers": 1,
  "effortDuration": 1,
  "enteredTime": "2024-11-07T02:41:00.8696317+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:00.8696317+02:00",
  "preparationStatus": "Unprepared",
  "preparationUser": "sample string 21",
  "preparationTime": "2024-11-07T02:41:00.8696317+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": "6ea5bd3a-c4b2-48a7-aaef-329da0448fb8",
      "formName": "sample string 2",
      "isMandatory": true,
      "callerId": "dd692a67-2921-487a-b782-d481fcdd03ad",
      "isCrossPlatform": true
    },
    {
      "formId": "6ea5bd3a-c4b2-48a7-aaef-329da0448fb8",
      "formName": "sample string 2",
      "isMandatory": true,
      "callerId": "dd692a67-2921-487a-b782-d481fcdd03ad",
      "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:00.8696317+02:00",
  "isConditional": true,
  "conditionalIndication": "sample string 26",
  "coSignAdministrationUser": "sample string 1",
  "sections": [
    {
      "startTime": "2024-11-07T02:41:00.8696317+02:00",
      "endTime": "2024-11-07T02:41:00.8696317+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:00.8696317+02:00",
      "endTime": "2024-11-07T02:41:00.8696317+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"
}