GET Orders Discovery

Developer Tools

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

Returns a list of valid Observation types for a given EMR installation.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

Released

Cerner

Released

Meditech

Released

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

OrderableTypeId

Gets or sets the orderable type identifier.

string

None

SearchString

Gets or sets the search value

string

Required if EMRSystem = Athena

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing collection of Orderable Types.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

OrderableTypeId

Gets or sets the orderable identifier.

string

None.

OrderableTypeDesc

Gets or sets the component desc.

string

None.

OrderableCodes

Gets or sets the short name.

Collection of OrderableCodeViewModel

None.

 
Response Codes

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

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
[
  {
    "OrderableTypeId": "sample string 1",
    "OrderableTypeDesc": "sample string 2",
    "OrderableCodes": [
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      },
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      }
    ]
  },
  {
    "OrderableTypeId": "sample string 1",
    "OrderableTypeDesc": "sample string 2",
    "OrderableCodes": [
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      },
      {
        "OrderableCodeId": "sample string 1",
        "OrderableCodeDesc": "sample string 2",
        "Active": true,
        "OrderableCodeIdentities": [
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          },
          {
            "Value": "sample string 1",
            "Type": "sample string 2"
          }
        ]
      }
    ]
  }
]
Sample Message
    <OrderableCodes>
      <OrderableCodeViewModel>
        <Active>true</Active>
        <OrderableCodeDesc>sample string 2</OrderableCodeDesc>
        <OrderableCodeId>sample string 1</OrderableCodeId>
        <OrderableCodeIdentities>
          <OrderableCodeIdentityViewModel>
            <Type>sample string 2</Type>
            <Value>sample string 1</Value>
          </OrderableCodeIdentityViewModel>
          <OrderableCodeIdentityViewModel>
            <Type>sample string 2</Type>
            <Value>sample string 1</Value>
          </OrderableCodeIdentityViewModel>
        </OrderableCodeIdentities>
      </OrderableCodeViewModel>
      <OrderableCodeViewModel>
        <Active>true</Active>
        <OrderableCodeDesc>sample string 2</OrderableCodeDesc>
        <OrderableCodeId>sample string 1</OrderableCodeId>
        <OrderableCodeIdentities>
          <OrderableCodeIdentityViewModel>
            <Type>sample string 2</Type>
            <Value>sample string 1</Value>
          </OrderableCodeIdentityViewModel>
          <OrderableCodeIdentityViewModel>
            <Type>sample string 2</Type>
            <Value>sample string 1</Value>
          </OrderableCodeIdentityViewModel>
        </OrderableCodeIdentities>
      </OrderableCodeViewModel>
    </OrderableCodes>
    <OrderableTypeDesc>sample string 2</OrderableTypeDesc>
    <OrderableTypeId>sample string 1</OrderableTypeId>
  </OrderableTypeViewModel>
</ArrayOfOrderableTypeViewModel>

Submit a Comment

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

 

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