GET Orders

Developer Tools

GET api/v1/{EMRSystem}/Orders

Returns Orders of all types (e.g. lab, patient care, radiology, medications) along with high-level order details for a given patient.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

Released

Cerner

Released

Meditech

Released

Sandbox

Released

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

UserType

Gets or sets the type of the user.

UserType

None

EncounterId

Gets or sets the encounter identifier.

string

None

OrderStatus

Gets or sets the status of the order.

OrderStatus

None

OrderTypes

Gets or sets the types of the order using a comma-seperated string.

string

None

FromDateTime

Gets or sets from date time.

date

None

ToDateTime

Gets or sets to date time.

date

None

MaxRecords

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

integer

None

IncludeAllOrders

Gets or sets a value indicating whether [include all orders].

boolean

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a collection of Orders.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Orders

Gets or sets the order.

Collection of BaseOrderResponseViewModel

None.

 
Response Codes

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

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
{
  "Orders": [
    {
      "PatientId": "sample string 1",
      "OrderId": "sample string 2",
      "EncounterId": "sample string 3",
      "OrderName": "sample string 4",
      "OrderStatus": "sample string 5",
      "OrderType": "sample string 6",
      "OrderedDateTime": "2018-02-14T17:44:55.0512258Z",
      "OrderClinicalDisplayLineLong": "sample string 7",
      "OrderClinicalDisplayLineShort": "sample string 8",
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "PatientId": "sample string 1",
      "OrderId": "sample string 2",
      "EncounterId": "sample string 3",
      "OrderName": "sample string 4",
      "OrderStatus": "sample string 5",
      "OrderType": "sample string 6",
      "OrderedDateTime": "2018-02-14T17:44:55.0512258Z",
      "OrderClinicalDisplayLineLong": "sample string 7",
      "OrderClinicalDisplayLineShort": "sample string 8",
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ]
}
Sample Message
<OrdersResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <Orders>
    <BaseOrderResponseViewModel>
      <EncounterId>sample string 3</EncounterId>
      <EncounterType xmlns:d4p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
        <d4p1:Id>sample string 1</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </EncounterType>
      <OrderClinicalDisplayLineLong>sample string 7</OrderClinicalDisplayLineLong>
      <OrderClinicalDisplayLineShort>sample string 8</OrderClinicalDisplayLineShort>
      <OrderId>sample string 2</OrderId>
      <OrderName>sample string 4</OrderName>
      <OrderStatus>sample string 5</OrderStatus>
      <OrderType>sample string 6</OrderType>
      <OrderedDateTime>2018-02-14T11:44:55.0512258-06:00</OrderedDateTime>
      <PatientClass xmlns:d4p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
        <d4p1:Id>sample string 1</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </PatientClass>
      <PatientId>sample string 1</PatientId>
    </BaseOrderResponseViewModel>
    <BaseOrderResponseViewModel>
      <EncounterId>sample string 3</EncounterId>
      <EncounterType xmlns:d4p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
        <d4p1:Id>sample string 1</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </EncounterType>
      <OrderClinicalDisplayLineLong>sample string 7</OrderClinicalDisplayLineLong>
      <OrderClinicalDisplayLineShort>sample string 8</OrderClinicalDisplayLineShort>
      <OrderId>sample string 2</OrderId>
      <OrderName>sample string 4</OrderName>
      <OrderStatus>sample string 5</OrderStatus>
      <OrderType>sample string 6</OrderType>
      <OrderedDateTime>2018-02-14T11:44:55.0512258-06:00</OrderedDateTime>
      <PatientClass xmlns:d4p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
        <d4p1:Id>sample string 1</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </PatientClass>
      <PatientId>sample string 1</PatientId>
    </BaseOrderResponseViewModel>
  </Orders>
</OrdersResponseViewModel>

Submit a Comment

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

 

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