GET Observations

Developer Tools

HTTP Method

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

Released

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

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

EncounterId

Gets or sets the encounter identifier.

string

None

CategoryId

Gets or sets the observation category identifier.

string

None

ComponentList

Gets or sets the component list.

string

None

MaxRecords

Gets or sets the maximum records. If not set, defaulted to 9999

integer

None

FromDateTime

Gets or sets from date.

date

None

ToDateTime

Gets or sets to date.

date

None

 
Body Parameters
None
 

Response Information

 
Resource Description
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:37:25.8522266Z",
    "ObservedDateTime": "2018-02-14T17:37:25.8522266Z",
    "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"
    }
  },
  {
    "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:37:25.8522266Z",
    "ObservedDateTime": "2018-02-14T17:37:25.8522266Z",
    "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
<ArrayOfObservationResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ObservationResponseViewModel>
    <CategoryDesc>sample string 3</CategoryDesc>
    <CategoryId>sample string 2</CategoryId>
    <ComponentDesc>sample string 6</ComponentDesc>
    <ComponentId>sample string 5</ComponentId>
    <EffectiveDateTime>2018-02-14T11:37:25.8522266-06:00</EffectiveDateTime>
    <EncounterId>sample string 15</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>
    <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:37:25.8522266-06:00</ObservedDateTime>
    <OrderId>sample string 4</OrderId>
    <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 14</PatientId>
  </ObservationResponseViewModel>
  <ObservationResponseViewModel>
    <CategoryDesc>sample string 3</CategoryDesc>
    <CategoryId>sample string 2</CategoryId>
    <ComponentDesc>sample string 6</ComponentDesc>
    <ComponentId>sample string 5</ComponentId>
    <EffectiveDateTime>2018-02-14T11:37:25.8522266-06:00</EffectiveDateTime>
    <EncounterId>sample string 15</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>
    <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:37:25.8522266-06:00</ObservedDateTime>
    <OrderId>sample string 4</OrderId>
    <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 14</PatientId>
  </ObservationResponseViewModel>
</ArrayOfObservationResponseViewModel>

Submit a Comment

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

 

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