GET api/v1/{EMRSystem}/Tasks/{TaskId}
Returns a task by task id.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets user identifier |
string |
None. |
| TaskId |
Gets or sets the task identifier. |
string |
Required |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
UdmTaskResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TaskId |
Gets or sets the task id. |
string |
None. |
| TaskClass |
Gets or sets the task class. |
CodedObject |
None. |
| TaskType |
Gets or sets the task type. |
CodedObject |
None. |
| TaskStatus |
Gets or sets the task status. |
CodedObject |
None. |
| TaskPriority |
Gets or sets the task priority. |
CodedObject |
None. |
| DocumentedBy |
Gets or sets the documented by prsnl. |
CodedObject |
None. |
| TaskPersonnelNotificationTo |
Gets or sets the task personnel notification to list. |
Collection of Provider |
None. |
| OrderId |
Gets or sets the order id. |
string |
None. |
| CreatedUpdatedDateTime |
Gets or sets the created updated date time. |
datetime |
None. |
| ScheduledDateTime |
Gets or sets the scheduled date time. |
datetime |
None. |
| TaskDateTime |
Gets or sets the scheduled date time. |
datetime |
None. |
| Encounter |
Gets or sets the encounter. |
Encounter |
None. |
| Patient |
Gets or sets the patient. |
BasePatient |
None. |
| Form |
Gets or sets the Form related to the task |
CodedObject |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
{
"TaskId": "sample string 1",
"TaskClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskPriority": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DocumentedBy": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"TaskPersonnelNotificationTo": [
{
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
},
{
"ProviderId": "sample string 1",
"ProviderName": "sample string 2"
}
],
"OrderId": "sample string 2",
"CreatedUpdatedDateTime": "2025-12-12T20:54:46.586411+00:00",
"ScheduledDateTime": "2025-12-12T20:54:46.5864681+00:00",
"TaskDateTime": "2025-12-12T20:54:46.5872289+00:00",
"Encounter": {
"EncounterId": "sample string 1",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"EncounterDateTime": "2025-12-12T20:54:46.5877996+00:00",
"DischargeDateTime": "2025-12-12T20:54:46.5878024+00:00",
"FinancialNumber": "sample string 2",
"Location": {
"BedId": "sample string 1",
"Bed": "sample string 2",
"RoomId": "sample string 3",
"Room": "sample string 4",
"UnitId": "sample string 5",
"Unit": "sample string 6",
"HospitalId": "sample string 7",
"Hospital": "sample string 8"
}
},
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "2025-12-12T20:54:46.5879558+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T20:54:46.5879593+00:00"
},
"Form": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}