GET Population Observations

Developer Tools

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

Returns all Observations (Flowsheets or Clinical Interventions) of all statuses for all patients for a given date range and filtered, optionally, by Locations (facilities) or Categories (list) or Components (list). Observations are used to document interventions during patient visits (e.g. vital signs, pulse oximetry, pain scale, etc.).

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

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

LocationList

Gets or sets the location list.

string

None

CategoryList

Gets or sets the category list.

string

None

ComponentList

Gets or sets the component list.

string

None

UserId

Gets or sets the user identifier.

string

Required

FromDateTime

Gets or sets from date time.

date

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Gets or sets to date time.

date

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a collection of Population Observations.

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.

date

None.

ObservedDateTime

Gets or sets the observed date time.

date

None.

NormalHigh

Gets or sets the normal high.

string

None.

NormalLow

Gets or sets the normal low.

string

None.

CreatedUpdatedDateTime

Gets or sets the created updated date time.

date

None.

Encounter

Gets or sets the encounter type.

EncounterViewModel

None.

Patient

Gets or sets the patient class.

BasePatientViewModel

None.

 
Response Codes

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

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-15T14:33:55.8863331Z",
    "ObservedDateTime": "2018-02-15T14:33:55.8863331Z",
    "NormalHigh": "sample string 12",
    "NormalLow": "sample string 13",
    "CreatedUpdatedDateTime": "2018-02-15T14:33:55.8863331Z",
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2018-02-15T14:33:55.8863331Z",
      "DischargeDateTime": "2018-02-15T14:33:55.8863331Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    },
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "sample string 7",
      "Gender": {
        "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-15T14:33:55.8863331Z",
    "ObservedDateTime": "2018-02-15T14:33:55.8863331Z",
    "NormalHigh": "sample string 12",
    "NormalLow": "sample string 13",
    "CreatedUpdatedDateTime": "2018-02-15T14:33:55.8863331Z",
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2018-02-15T14:33:55.8863331Z",
      "DischargeDateTime": "2018-02-15T14:33:55.8863331Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    },
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "sample string 7",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  }
]
Sample Message
<ArrayOfPopulationObservationResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PopulationObservationResponseViewModel>
    <CategoryDesc>sample string 3</CategoryDesc>
    <CategoryId>sample string 2</CategoryId>
    <ComponentDesc>sample string 6</ComponentDesc>
    <ComponentId>sample string 5</ComponentId>
    <CreatedUpdatedDateTime>2018-02-15T08:33:55.8863331-06:00</CreatedUpdatedDateTime>
    <EffectiveDateTime>2018-02-15T08:33:55.8863331-06:00</EffectiveDateTime>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-15T08:33:55.8863331-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-15T08:33:55.8863331-06:00</d3p1:EncounterDateTime>
      <d3p1:EncounterId>sample string 1</d3p1:EncounterId>
      <d3p1:EncounterType>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:EncounterType>
      <d3p1:FinancialNumber>sample string 2</d3p1:FinancialNumber>
      <d3p1:Location>
        <d3p1:Bed>sample string 1</d3p1:Bed>
        <d3p1:Hospital>sample string 3</d3p1:Hospital>
        <d3p1:Room>sample string 4</d3p1:Room>
        <d3p1:Unit>sample string 2</d3p1:Unit>
      </d3p1:Location>
      <d3p1:PatientClass>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:PatientClass>
    </Encounter>
    <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-15T08:33:55.8863331-06:00</ObservedDateTime>
    <OrderId>sample string 4</OrderId>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
  </PopulationObservationResponseViewModel>
  <PopulationObservationResponseViewModel>
    <CategoryDesc>sample string 3</CategoryDesc>
    <CategoryId>sample string 2</CategoryId>
    <ComponentDesc>sample string 6</ComponentDesc>
    <ComponentId>sample string 5</ComponentId>
    <CreatedUpdatedDateTime>2018-02-15T08:33:55.8863331-06:00</CreatedUpdatedDateTime>
    <EffectiveDateTime>2018-02-15T08:33:55.8863331-06:00</EffectiveDateTime>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-15T08:33:55.8863331-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-15T08:33:55.8863331-06:00</d3p1:EncounterDateTime>
      <d3p1:EncounterId>sample string 1</d3p1:EncounterId>
      <d3p1:EncounterType>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:EncounterType>
      <d3p1:FinancialNumber>sample string 2</d3p1:FinancialNumber>
      <d3p1:Location>
        <d3p1:Bed>sample string 1</d3p1:Bed>
        <d3p1:Hospital>sample string 3</d3p1:Hospital>
        <d3p1:Room>sample string 4</d3p1:Room>
        <d3p1:Unit>sample string 2</d3p1:Unit>
      </d3p1:Location>
      <d3p1:PatientClass>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:PatientClass>
    </Encounter>
    <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-15T08:33:55.8863331-06:00</ObservedDateTime>
    <OrderId>sample string 4</OrderId>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
  </PopulationObservationResponseViewModel>
</ArrayOfPopulationObservationResponseViewModel>:48.3278807-06:00</d3p1:ReportDateTime>
        <d3p1:ReportStatus>sample string 3</d3p1:ReportStatus>
      </d3p1:MicroReportViewModel>
    </MicroReports>
    <MicroTestDesc>sample string 4</MicroTestDesc>
    <MicroTestId>sample string 3</MicroTestId>
    <NormalHigh>sample string 6</NormalHigh>
    <NormalLow>sample string 7</NormalLow>
    <Normalcy>sample string 8</Normalcy>
    <OrderId>sample string 2</OrderId>
    <OrderingProvider xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
      <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
    </OrderingProvider>
    <Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
      <d3p1:DisplayName>sample string 2</d3p1:DisplayName>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:Gender>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Gender>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MRN>sample string 6</d3p1:MRN>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PatientId>sample string 1</d3p1:PatientId>
    </Patient>
    <ResultDateTime>2018-02-15T08:26:48.3278807-06:00</ResultDateTime>
    <ResultId>sample string 1</ResultId>
    <SpecimenSource>sample string 9</SpecimenSource>
    <SpecimenType>sample string 10</SpecimenType>
    <Value>sample string 5</Value>
  </PopulationMicroResultResponseViewModel>
</ArrayOfPopulationMicroResultResponseViewModel>

Submit a Comment

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

 

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