GET Orders by Id

Developer Tools

GET api/v1/{EMRSystem}/Orders/{OrderId}

Returns Order details for a given Order ID.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

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

OrderId

The order identifier.

string

Required

UserId

Gets or sets the user identifier.

string

Required

UserType

Gets or sets the type of the user.

UserType

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a single Order.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Order

Gets or sets the order.

OrderResponseViewModel

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
{
  "Order": {
    "AlternativeOrderName": "sample string 1",
    "OrderedBy": "sample string 2",
    "ActionPersonnel": "sample string 3",
    "OrderStartDateTime": "2018-02-14T17:55:38.630201Z",
    "OrderStopDateTime": "2018-02-14T17:55:38.630201Z",
    "DepartmentStatus": "sample string 4",
    "OrderDetails": [
      {
        "Code": "sample string 1",
        "Display": "sample string 2",
        "DisplaySequence": "sample string 3",
        "GroupSequence": "sample string 4",
        "Value": "sample string 5"
      },
      {
        "Code": "sample string 1",
        "Display": "sample string 2",
        "DisplaySequence": "sample string 3",
        "GroupSequence": "sample string 4",
        "Value": "sample string 5"
      }
    ],
    "OrderComments": [
      {
        "CommentType": "sample string 1",
        "Comments": [
          {
            "CommentText": "sample string 1",
            "CommentUpdateDateTime": "2018-02-14T17:55:38.6458264Z",
            "CommentUpdatePersonnel": "sample string 2"
          },
          {
            "CommentText": "sample string 1",
            "CommentUpdateDateTime": "2018-02-14T17:55:38.6458264Z",
            "CommentUpdatePersonnel": "sample string 2"
          }
        ]
      },
      {
        "CommentType": "sample string 1",
        "Comments": [
          {
            "CommentText": "sample string 1",
            "CommentUpdateDateTime": "2018-02-14T17:55:38.6458264Z",
            "CommentUpdatePersonnel": "sample string 2"
          },
          {
            "CommentText": "sample string 1",
            "CommentUpdateDateTime": "2018-02-14T17:55:38.6458264Z",
            "CommentUpdatePersonnel": "sample string 2"
          }
        ]
      }
    ],
    "PatientId": "sample string 5",
    "OrderId": "sample string 6",
    "EncounterId": "sample string 7",
    "OrderName": "sample string 8",
    "OrderStatus": "sample string 9",
    "OrderType": "sample string 10",
    "OrderedDateTime": "2018-02-14T17:55:38.6458264Z",
    "OrderClinicalDisplayLineLong": "sample string 11",
    "OrderClinicalDisplayLineShort": "sample string 12",
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  }
}
Sample Message
<SingleOrderResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <Order>
    <EncounterId>sample string 7</EncounterId>
    <EncounterType xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </EncounterType>
    <OrderClinicalDisplayLineLong>sample string 11</OrderClinicalDisplayLineLong>
    <OrderClinicalDisplayLineShort>sample string 12</OrderClinicalDisplayLineShort>
    <OrderId>sample string 6</OrderId>
    <OrderName>sample string 8</OrderName>
    <OrderStatus>sample string 9</OrderStatus>
    <OrderType>sample string 10</OrderType>
    <OrderedDateTime>2018-02-14T11:55:38.6458264-06:00</OrderedDateTime>
    <PatientClass xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Id>sample string 1</d3p1:Id>
      <d3p1:Name>sample string 2</d3p1:Name>
    </PatientClass>
    <PatientId>sample string 5</PatientId>
    <ActionPersonnel>sample string 3</ActionPersonnel>
    <AlternativeOrderName>sample string 1</AlternativeOrderName>
    <DepartmentStatus>sample string 4</DepartmentStatus>
    <OrderComments xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:OrderCommentViewModel>
        <d3p1:CommentType>sample string 1</d3p1:CommentType>
        <d3p1:Comments>
          <d3p1:CommentViewModel>
            <d3p1:CommentText>sample string 1</d3p1:CommentText>
            <d3p1:CommentUpdateDateTime>2018-02-14T11:55:38.6458264-06:00</d3p1:CommentUpdateDateTime>
            <d3p1:CommentUpdatePersonnel>sample string 2</d3p1:CommentUpdatePersonnel>
          </d3p1:CommentViewModel>
          <d3p1:CommentViewModel>
            <d3p1:CommentText>sample string 1</d3p1:CommentText>
            <d3p1:CommentUpdateDateTime>2018-02-14T11:55:38.6458264-06:00</d3p1:CommentUpdateDateTime>
            <d3p1:CommentUpdatePersonnel>sample string 2</d3p1:CommentUpdatePersonnel>
          </d3p1:CommentViewModel>
        </d3p1:Comments>
      </d3p1:OrderCommentViewModel>
      <d3p1:OrderCommentViewModel>
        <d3p1:CommentType>sample string 1</d3p1:CommentType>
        <d3p1:Comments>
          <d3p1:CommentViewModel>
            <d3p1:CommentText>sample string 1</d3p1:CommentText>
            <d3p1:CommentUpdateDateTime>2018-02-14T11:55:38.6458264-06:00</d3p1:CommentUpdateDateTime>
            <d3p1:CommentUpdatePersonnel>sample string 2</d3p1:CommentUpdatePersonnel>
          </d3p1:CommentViewModel>
          <d3p1:CommentViewModel>
            <d3p1:CommentText>sample string 1</d3p1:CommentText>
            <d3p1:CommentUpdateDateTime>2018-02-14T11:55:38.6458264-06:00</d3p1:CommentUpdateDateTime>
            <d3p1:CommentUpdatePersonnel>sample string 2</d3p1:CommentUpdatePersonnel>
          </d3p1:CommentViewModel>
        </d3p1:Comments>
      </d3p1:OrderCommentViewModel>
    </OrderComments>
    <OrderDetails xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:OrderDetailViewModel>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:Display>sample string 2</d3p1:Display>
        <d3p1:DisplaySequence>sample string 3</d3p1:DisplaySequence>
        <d3p1:GroupSequence>sample string 4</d3p1:GroupSequence>
        <d3p1:Value>sample string 5</d3p1:Value>
      </d3p1:OrderDetailViewModel>
      <d3p1:OrderDetailViewModel>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:Display>sample string 2</d3p1:Display>
        <d3p1:DisplaySequence>sample string 3</d3p1:DisplaySequence>
        <d3p1:GroupSequence>sample string 4</d3p1:GroupSequence>
        <d3p1:Value>sample string 5</d3p1:Value>
      </d3p1:OrderDetailViewModel>
    </OrderDetails>
    <OrderStartDateTime>2018-02-14T11:55:38.630201-06:00</OrderStartDateTime>
    <OrderStopDateTime>2018-02-14T11:55:38.630201-06:00</OrderStopDateTime>
    <OrderedBy>sample string 2</OrderedBy>
  </Order>
</SingleOrderResponseViewModel>

Submit a Comment

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

 

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