GET Observations Discovery

Developer Tools

GET api/v1/{EMRSystem}/Observations/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

CategoryId

Gets or sets the category identifier.

string

None

Domain

Gets or sets the domain (***required for Cerner only***). This Domain will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Cerner

LoginId

Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Sandbox

Password

Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Sandbox

EmrInstance

Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.

string

None

ApplicationName

Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys

ApplicationKey

Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing collection of Observation Categories.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

CategoryId

Gets or sets the category identifier.

string

None.

CategoryDesc

Gets or sets the category desc.

string

None.

DisplaySequence

Gets or sets the display sequence.

string

None.

ObservationComponents

Gets or sets the observation components.

Collection of ObservationComponentViewModel

None.

ObservationCategories

Gets or sets the observation categories.

Collection of ObservationCategoryViewModel

None.

 
Response Codes

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

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
Not Applicable
Sample Message
Not Applicable

Submit a Comment

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

 

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