GET v1/serviceprovider/GetOrders?mode={mode}&serviceProviderConnectionAuthCode={serviceProviderConnectionAuthCode}

Get Service Provider Orders: Get Orders destined for a service provider. This can be used by a lab or imaging provider to retrieve orders from EMR-Link queued up and ready for that service provider. This call must be followed up with a call to ConfirmGetOrders to acknowledge the successful download.

Request Information

URI Parameters

Name	Description	Type	Additional information
mode	Determines whether the orders retrieved are test mode or live (aka production) mode orders. Specify 'live' to retrieve live orders. If empty or any other value, only test mode orders are retrieved.	string	Default value is
serviceProviderConnectionAuthCode	This parameter must be used to identify the specific lab/imaging connection if the service provider "owns" more than one connection in EMR-Link. If left empty, and the service provider owns more than one lab/imaging connection, an error will be returned. If the service provider owns only one service provider connection, this parameter can be ignored.	string	Default value is

Body Parameters

None.

Response Information

Resource Description

ServiceProviderGetOrdersBaseResponse

Name	Description	Type	Additional information
OrderFileList	List of OrderFile objects	Collection of OrderFile	None.
AckResponse	Ack Response to be sent back in the ConfirmGetOrders method for confirmation of successful storing of order files on caller's end.	string	None.
Error	Will be set to True if any errors occur during the processing of the API method.	boolean	None.
ErrorMessage	Will contain an error message string if Error is True.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderFileList": [
    {
      "FileName": "sample string 1",
      "FileContents": "sample string 2"
    },
    {
      "FileName": "sample string 1",
      "FileContents": "sample string 2"
    }
  ],
  "AckResponse": "sample string 1",
  "Error": true,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<ServiceProviderGetOrdersBaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 3</ErrorMessage>
  <OrderFileList>
    <OrderFile>
      <FileName>sample string 1</FileName>
      <FileContents>sample string 2</FileContents>
    </OrderFile>
    <OrderFile>
      <FileName>sample string 1</FileName>
      <FileContents>sample string 2</FileContents>
    </OrderFile>
  </OrderFileList>
  <AckResponse>sample string 1</AckResponse>
</ServiceProviderGetOrdersBaseResponse>