GET api/v1/{EMRSystem}/IntakeOutputs
Returns the fluid Intake and Output volumes for a given patient, given date range and shift totals as defined by the EMR.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| EncounterId |
Gets or sets the encounter identifier. |
string |
Required |
| FromDateTime |
Gets or sets the from date/time. |
datetime |
None. |
| ToDateTime |
Gets or sets the to date/time. |
datetime |
None. |
| MaxRecords |
Gets or sets the maximum records. If not set, defaulted to 9999 |
integer |
None. |
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
UdmIntakeOutputsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| EncounterType |
Gets or sets the encounter type. |
CodedObject |
None. |
| PatientClass |
Gets or sets the patient class. |
CodedObject |
None. |
| FromDateTime |
Gets or sets the from date/time. |
datetime |
None. |
| ToDateTime |
Gets or sets the to date/time. |
datetime |
None. |
| Volumes |
Gets or sets the volumes. |
Collection of Volume |
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
{
"PatientId": "sample string 1",
"EncounterId": "sample string 2",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"FromDateTime": "2025-12-12T21:04:26.0552687+00:00",
"ToDateTime": "2025-12-12T21:04:26.055407+00:00",
"Volumes": [
{
"ResultId": "sample string 1",
"ResultName": "sample string 2",
"ComponentId": "sample string 3",
"OrderId": "sample string 4",
"IntakeOrOutput": "sample string 5",
"VolumeStartDateTime": "2025-12-12T21:04:26.0563951+00:00",
"VolumeEndDateTime": "2025-12-12T21:04:26.0565541+00:00",
"VolumeStatus": "sample string 6",
"VolumeTotal": "sample string 7",
"VolumeUnits": "sample string 8",
"VolumeType": "sample string 9"
},
{
"ResultId": "sample string 1",
"ResultName": "sample string 2",
"ComponentId": "sample string 3",
"OrderId": "sample string 4",
"IntakeOrOutput": "sample string 5",
"VolumeStartDateTime": "2025-12-12T21:04:26.0563951+00:00",
"VolumeEndDateTime": "2025-12-12T21:04:26.0565541+00:00",
"VolumeStatus": "sample string 6",
"VolumeTotal": "sample string 7",
"VolumeUnits": "sample string 8",
"VolumeType": "sample string 9"
}
]
}