GET Intake Outputs

Developer Tools

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.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

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.

date

None

ToDateTime

Gets or sets the to date/time.

date

None

MaxRecords

Gets or sets the maximum records. If not set, defaulted to 9999

integer

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing collection of Intakes and Outputs.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

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.

CodedObjectViewModel

None.

PatientClass

Gets or sets the patient class.

CodedObjectViewModel

None.

FromDateTime

Gets or sets the from date/time.

date

None.

ToDateTime

Gets or sets the to date/time.

date

None.

Volumes

Gets or sets the volumes.

VolumeViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.IntakeOutputsResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
{
  "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": "2018-02-14T14:42:54.3337674Z",
  "ToDateTime": "2018-02-14T14:42:54.3337674Z",
  "Volumes": [
    {
      "ResultId": "sample string 1",
      "ResultName": "sample string 2",
      "ComponentId": "sample string 3",
      "OrderId": "sample string 4",
      "IntakeOrOutput": "sample string 5",
      "VolumeStartDateTime": "2018-02-14T14:42:54.3337674Z",
      "VolumeEndDateTime": "2018-02-14T14:42:54.3337674Z",
      "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": "2018-02-14T14:42:54.3337674Z",
      "VolumeEndDateTime": "2018-02-14T14:42:54.3337674Z",
      "VolumeStatus": "sample string 6",
      "VolumeTotal": "sample string 7",
      "VolumeUnits": "sample string 8",
      "VolumeType": "sample string 9"
    }
  ]
}
Sample Message
<IntakeOutputsResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <EncounterId>sample string 2</EncounterId>
  <EncounterType xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </EncounterType>
  <FromDateTime>2018-02-14T08:42:54.3337674-06:00</FromDateTime>
  <PatientClass xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </PatientClass>
  <PatientId>sample string 1</PatientId>
  <ToDateTime>2018-02-14T08:42:54.3337674-06:00</ToDateTime>
  <Volumes xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:VolumeViewModel>
      <d2p1:ComponentId>sample string 3</d2p1:ComponentId>
      <d2p1:IntakeOrOutput>sample string 5</d2p1:IntakeOrOutput>
      <d2p1:OrderId>sample string 4</d2p1:OrderId>
      <d2p1:ResultId>sample string 1</d2p1:ResultId>
      <d2p1:ResultName>sample string 2</d2p1:ResultName>
      <d2p1:VolumeEndDateTime>2018-02-14T08:42:54.3337674-06:00</d2p1:VolumeEndDateTime>
      <d2p1:VolumeStartDateTime>2018-02-14T08:42:54.3337674-06:00</d2p1:VolumeStartDateTime>
      <d2p1:VolumeStatus>sample string 6</d2p1:VolumeStatus>
      <d2p1:VolumeTotal>sample string 7</d2p1:VolumeTotal>
      <d2p1:VolumeType>sample string 9</d2p1:VolumeType>
      <d2p1:VolumeUnits>sample string 8</d2p1:VolumeUnits>
    </d2p1:VolumeViewModel>
    <d2p1:VolumeViewModel>
      <d2p1:ComponentId>sample string 3</d2p1:ComponentId>
      <d2p1:IntakeOrOutput>sample string 5</d2p1:IntakeOrOutput>
      <d2p1:OrderId>sample string 4</d2p1:OrderId>
      <d2p1:ResultId>sample string 1</d2p1:ResultId>
      <d2p1:ResultName>sample string 2</d2p1:ResultName>
      <d2p1:VolumeEndDateTime>2018-02-14T08:42:54.3337674-06:00</d2p1:VolumeEndDateTime>
      <d2p1:VolumeStartDateTime>2018-02-14T08:42:54.3337674-06:00</d2p1:VolumeStartDateTime>
      <d2p1:VolumeStatus>sample string 6</d2p1:VolumeStatus>
      <d2p1:VolumeTotal>sample string 7</d2p1:VolumeTotal>
      <d2p1:VolumeType>sample string 9</d2p1:VolumeType>
      <d2p1:VolumeUnits>sample string 8</d2p1:VolumeUnits>
    </d2p1:VolumeViewModel>
  </Volumes>
</IntakeOutputsResponseViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?