GET References Discovery

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

Returns the Reference Codes available within the installed EMR system.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Analytics
Interactive

Allscripts

Released

Athena

Released

Cerner

Released

Epic

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

ServiceName

Gets or sets the name of the service.

ServiceName

Required

RequestOrResponse

Request or Response Object

RequestOrResponse

Required

FieldPathAndName

Gets or sets the path and name of the field.

string

Required

IncludeInactive

Gets or sets a value indicating whether [include inactive].

boolean

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing Reference Discovery Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Codes

Gets or sets the codes.

Collection of ReferenceCodeViewModel

None.

 
Response Codes

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

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
{
  "Codes": [
    {
      "Active": true,
      "Id": "sample string 1",
      "Description": "sample string 2",
      "Display": "sample string 3",
      "KeyName": "sample string 4",
      "Synonyms": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Active": true,
      "Id": "sample string 1",
      "Description": "sample string 2",
      "Display": "sample string 3",
      "KeyName": "sample string 4",
      "Synonyms": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}
Sample Message
<ReferenceDiscoveryResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <Codes xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:ReferenceCodeViewModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Display>sample string 3</d2p1:Display>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:KeyName>sample string 4</d2p1:KeyName>
      <d2p1:Synonyms xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Synonyms>
    </d2p1:ReferenceCodeViewModel>
    <d2p1:ReferenceCodeViewModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Display>sample string 3</d2p1:Display>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:KeyName>sample string 4</d2p1:KeyName>
      <d2p1:Synonyms xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Synonyms>
    </d2p1:ReferenceCodeViewModel>
  </Codes>
</ReferenceDiscoveryResponseViewModel>

Submit a Comment

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

 

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