GET Observations by Id

Developer Tools

GET api/v1/{EMRSystem}/Observations/{ObservationId}

Returns the details of the Observation (Flowsheets or Clinical Interventions) for a given identifier.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

Released

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

ObservationId

The observation identifier.

string

Required

UserId

Gets or sets the user identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing an Observation.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

ObservationId

Gets or sets the Observation identifier.

string

None.

CategoryId

Gets or sets the Category identifier.

string

None.

CategoryDesc

Gets or sets the Category description.

string

None.

OrderId

Gets or sets the order identifier.

string

None.

ComponentId

Gets or sets the component identifier.

string

None.

ComponentDesc

Gets or sets the component desc.

string

None.

ObservationType

Gets or sets the type of the Observation.

string

None.

ObservationStatus

Gets or sets the Observation status.

string

None.

ObservationValue

Gets or sets the Observation value.

string

None.

ObservationUnits

Gets or sets the Observation units.

string

None.

Normalcy

Gets or sets the normalcy.

string

None.

EffectiveDateTime

Gets or sets the effective date time.

string

None.

ObservedDateTime

Gets or sets the observed date time.

string

None.

NormalHigh

Gets or sets the normal high.

string

None.

NormalLow

Gets or sets the normal low.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

EncounterId

Gets or sets the encounter identifier.

string

None.

EncounterType

Gets or sets the encounter type.

CodedObjectViewModel

None.

PatientClass

Gets or sets the patient class.

CodedObjectViewModel

None.

 
Response Codes

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

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
{
  "ObservationId": "sample string 1",
  "CategoryId": "sample string 2",
  "CategoryDesc": "sample string 3",
  "OrderId": "sample string 4",
  "ComponentId": "sample string 5",
  "ComponentDesc": "sample string 6",
  "ObservationType": "sample string 7",
  "ObservationStatus": "sample string 8",
  "ObservationValue": "sample string 9",
  "ObservationUnits": "sample string 10",
  "Normalcy": "sample string 11",
  "EffectiveDateTime": "2018-02-14T17:10:44.8198194Z",
  "ObservedDateTime": "2018-02-14T17:10:44.8198194Z",
  "NormalHigh": "sample string 12",
  "NormalLow": "sample string 13",
  "PatientId": "sample string 14",
  "EncounterId": "sample string 15",
  "EncounterType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PatientClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  }
}
Sample Message
<ObservationResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <CategoryDesc>sample string 3</CategoryDesc>
  <CategoryId>sample string 2</CategoryId>
  <ComponentDesc>sample string 6</ComponentDesc>
  <ComponentId>sample string 5</ComponentId>
  <EffectiveDateTime>2018-02-14T11:10:44.8198194-06:00</EffectiveDateTime>
  <EncounterId>sample string 15</EncounterId>
  <EncounterType xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </EncounterType>
  <NormalHigh>sample string 12</NormalHigh>
  <NormalLow>sample string 13</NormalLow>
  <Normalcy>sample string 11</Normalcy>
  <ObservationId>sample string 1</ObservationId>
  <ObservationStatus>sample string 8</ObservationStatus>
  <ObservationType>sample string 7</ObservationType>
  <ObservationUnits>sample string 10</ObservationUnits>
  <ObservationValue>sample string 9</ObservationValue>
  <ObservedDateTime>2018-02-14T11:10:44.8198194-06:00</ObservedDateTime>
  <OrderId>sample string 4</OrderId>
  <PatientClass xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </PatientClass>
  <PatientId>sample string 14</PatientId>
</ObservationResponseViewModel>

Submit a Comment

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

 

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