GET Population Lab Results

Developer Tools

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

Returns all Lab Results of all statuses for all patients for a given date range and filtered, optionally, by locations (facilities) or lab components (list).

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

ComponentIdList

Gets or sets the component identifier list (comma delimitted).

string

None

LocationList

Gets or sets the location 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 List of population based Lab Results.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

ClinicallySignificantUpdateDateTime

Gets the clinically significant update date time.

date

None.

CollectedDateTime

Gets the collected date time.

date

None.

ComponentDesc

Gets the component desc.

string

None.

ComponentId

Gets the component identifier.

string

None.

CreatedUpdatedDateTime

Gets or sets the created updated date time.

date

None.

Encounter

Gets the encounter.

EncounterViewModel

None.

Flag

Gets the flag.

string

None.

LabLocations

Gets the lab locations.

Collection of LabLocationViewModel

None.

LOINC

Gets the loinc.

string

None.

Normalcy

Gets the normalcy.

string

None.

NormalHigh

Gets the normal high.

string

None.

NormalLow

Gets the normal low.

string

None.

Notes

Gets the notes.

Collection of NoteViewModel

None.

OrderId

Gets the order identifier.

string

None.

Patient

Gets the patient.

BasePatientViewModel

None.

ResultDateTime

Gets the result date time.

date

None.

ResultId

Gets the result identifier.

string

None.

Status

Gets the status.

string

None.

Units

Gets the units.

string

None.

Value

Gets the value.

string

None.

OrderingProvider

Gets or sets the ordering provider.

ProviderViewModel

None.

 
Response Codes

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

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
[
  {
    "ClinicallySignificantUpdateDateTime": "2018-02-14T21:49:39.4939378Z",
    "CollectedDateTime": "2018-02-14T21:49:39.4939378Z",
    "ComponentDesc": "sample string 1",
    "ComponentId": "sample string 2",
    "CreatedUpdatedDateTime": "2018-02-14T21:49:39.4939378Z",
    "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-14T21:49:39.4939378Z",
      "DischargeDateTime": "2018-02-14T21:49:39.4939378Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    },
    "Flag": "sample string 3",
    "LabLocations": [
      {
        "LabName": "sample string 1",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "ZIP": "sample string 6",
          "Type": "sample string 7",
          "Country": "sample string 8"
        },
        "Telephone": "sample string 2"
      },
      {
        "LabName": "sample string 1",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "ZIP": "sample string 6",
          "Type": "sample string 7",
          "Country": "sample string 8"
        },
        "Telephone": "sample string 2"
      }
    ],
    "LOINC": "sample string 4",
    "Normalcy": "sample string 5",
    "NormalHigh": "sample string 6",
    "NormalLow": "sample string 7",
    "Notes": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-14T21:49:39.4939378Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-14T21:49:39.4939378Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      }
    ],
    "OrderId": "sample string 8",
    "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"
      }
    },
    "ResultDateTime": "2018-02-14T21:49:39.4939378Z",
    "ResultId": "sample string 9",
    "Status": "sample string 10",
    "Units": "sample string 11",
    "Value": "sample string 12",
    "OrderingProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    }
  },
  {
    "ClinicallySignificantUpdateDateTime": "2018-02-14T21:49:39.4939378Z",
    "CollectedDateTime": "2018-02-14T21:49:39.4939378Z",
    "ComponentDesc": "sample string 1",
    "ComponentId": "sample string 2",
    "CreatedUpdatedDateTime": "2018-02-14T21:49:39.4939378Z",
    "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-14T21:49:39.4939378Z",
      "DischargeDateTime": "2018-02-14T21:49:39.4939378Z",
      "FinancialNumber": "sample string 2",
      "Location": {
        "Bed": "sample string 1",
        "Unit": "sample string 2",
        "Hospital": "sample string 3",
        "Room": "sample string 4"
      }
    },
    "Flag": "sample string 3",
    "LabLocations": [
      {
        "LabName": "sample string 1",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "ZIP": "sample string 6",
          "Type": "sample string 7",
          "Country": "sample string 8"
        },
        "Telephone": "sample string 2"
      },
      {
        "LabName": "sample string 1",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "ZIP": "sample string 6",
          "Type": "sample string 7",
          "Country": "sample string 8"
        },
        "Telephone": "sample string 2"
      }
    ],
    "LOINC": "sample string 4",
    "Normalcy": "sample string 5",
    "NormalHigh": "sample string 6",
    "NormalLow": "sample string 7",
    "Notes": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-14T21:49:39.4939378Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-14T21:49:39.4939378Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      }
    ],
    "OrderId": "sample string 8",
    "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"
      }
    },
    "ResultDateTime": "2018-02-14T21:49:39.4939378Z",
    "ResultId": "sample string 9",
    "Status": "sample string 10",
    "Units": "sample string 11",
    "Value": "sample string 12",
    "OrderingProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    }
  }
]
Sample Message
<ArrayOfPopulationLabResultResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PopulationLabResultResponseViewModel>
    <ClinicallySignificantUpdateDateTime>2018-02-14T15:49:39.4939378-06:00</ClinicallySignificantUpdateDateTime>
    <CollectedDateTime>2018-02-14T15:49:39.4939378-06:00</CollectedDateTime>
    <ComponentDesc>sample string 1</ComponentDesc>
    <ComponentId>sample string 2</ComponentId>
    <CreatedUpdatedDateTime>2018-02-14T15:49:39.4939378-06:00</CreatedUpdatedDateTime>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-14T15:49:39.4939378-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-14T15:49:39.4939378-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>
    <Flag>sample string 3</Flag>
    <LOINC>sample string 4</LOINC>
    <LabLocations xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:LabLocationViewModel>
        <d3p1:Address>
          <d3p1:Address1>sample string 2</d3p1:Address1>
          <d3p1:Address2>sample string 3</d3p1:Address2>
          <d3p1:AddressId>sample string 1</d3p1:AddressId>
          <d3p1:City>sample string 4</d3p1:City>
          <d3p1:Country>sample string 8</d3p1:Country>
          <d3p1:State>sample string 5</d3p1:State>
          <d3p1:Type>sample string 7</d3p1:Type>
          <d3p1:ZIP>sample string 6</d3p1:ZIP>
        </d3p1:Address>
        <d3p1:LabName>sample string 1</d3p1:LabName>
        <d3p1:Telephone>sample string 2</d3p1:Telephone>
      </d3p1:LabLocationViewModel>
      <d3p1:LabLocationViewModel>
        <d3p1:Address>
          <d3p1:Address1>sample string 2</d3p1:Address1>
          <d3p1:Address2>sample string 3</d3p1:Address2>
          <d3p1:AddressId>sample string 1</d3p1:AddressId>
          <d3p1:City>sample string 4</d3p1:City>
          <d3p1:Country>sample string 8</d3p1:Country>
          <d3p1:State>sample string 5</d3p1:State>
          <d3p1:Type>sample string 7</d3p1:Type>
          <d3p1:ZIP>sample string 6</d3p1:ZIP>
        </d3p1:Address>
        <d3p1:LabName>sample string 1</d3p1:LabName>
        <d3p1:Telephone>sample string 2</d3p1:Telephone>
      </d3p1:LabLocationViewModel>
    </LabLocations>
    <NormalHigh>sample string 6</NormalHigh>
    <NormalLow>sample string 7</NormalLow>
    <Normalcy>sample string 5</Normalcy>
    <Notes xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:NoteViewModel>
        <d3p1:Comments>sample string 1</d3p1:Comments>
        <d3p1:Format>sample string 2</d3p1:Format>
        <d3p1:NoteDateTime>2018-02-14T15:49:39.4939378-06:00</d3p1:NoteDateTime>
        <d3p1:Provider>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:Provider>
      </d3p1:NoteViewModel>
      <d3p1:NoteViewModel>
        <d3p1:Comments>sample string 1</d3p1:Comments>
        <d3p1:Format>sample string 2</d3p1:Format>
        <d3p1:NoteDateTime>2018-02-14T15:49:39.4939378-06:00</d3p1:NoteDateTime>
        <d3p1:Provider>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:Provider>
      </d3p1:NoteViewModel>
    </Notes>
    <OrderId>sample string 8</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-14T15:49:39.4939378-06:00</ResultDateTime>
    <ResultId>sample string 9</ResultId>
    <Status>sample string 10</Status>
    <Units>sample string 11</Units>
    <Value>sample string 12</Value>
  </PopulationLabResultResponseViewModel>
  <PopulationLabResultResponseViewModel>
    <ClinicallySignificantUpdateDateTime>2018-02-14T15:49:39.4939378-06:00</ClinicallySignificantUpdateDateTime>
    <CollectedDateTime>2018-02-14T15:49:39.4939378-06:00</CollectedDateTime>
    <ComponentDesc>sample string 1</ComponentDesc>
    <ComponentId>sample string 2</ComponentId>
    <CreatedUpdatedDateTime>2018-02-14T15:49:39.4939378-06:00</CreatedUpdatedDateTime>
    <Encounter xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:DischargeDateTime>2018-02-14T15:49:39.4939378-06:00</d3p1:DischargeDateTime>
      <d3p1:EncounterDateTime>2018-02-14T15:49:39.4939378-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>
    <Flag>sample string 3</Flag>
    <LOINC>sample string 4</LOINC>
    <LabLocations xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:LabLocationViewModel>
        <d3p1:Address>
          <d3p1:Address1>sample string 2</d3p1:Address1>
          <d3p1:Address2>sample string 3</d3p1:Address2>
          <d3p1:AddressId>sample string 1</d3p1:AddressId>
          <d3p1:City>sample string 4</d3p1:City>
          <d3p1:Country>sample string 8</d3p1:Country>
          <d3p1:State>sample string 5</d3p1:State>
          <d3p1:Type>sample string 7</d3p1:Type>
          <d3p1:ZIP>sample string 6</d3p1:ZIP>
        </d3p1:Address>
        <d3p1:LabName>sample string 1</d3p1:LabName>
        <d3p1:Telephone>sample string 2</d3p1:Telephone>
      </d3p1:LabLocationViewModel>
      <d3p1:LabLocationViewModel>
        <d3p1:Address>
          <d3p1:Address1>sample string 2</d3p1:Address1>
          <d3p1:Address2>sample string 3</d3p1:Address2>
          <d3p1:AddressId>sample string 1</d3p1:AddressId>
          <d3p1:City>sample string 4</d3p1:City>
          <d3p1:Country>sample string 8</d3p1:Country>
          <d3p1:State>sample string 5</d3p1:State>
          <d3p1:Type>sample string 7</d3p1:Type>
          <d3p1:ZIP>sample string 6</d3p1:ZIP>
        </d3p1:Address>
        <d3p1:LabName>sample string 1</d3p1:LabName>
        <d3p1:Telephone>sample string 2</d3p1:Telephone>
      </d3p1:LabLocationViewModel>
    </LabLocations>
    <NormalHigh>sample string 6</NormalHigh>
    <NormalLow>sample string 7</NormalLow>
    <Normalcy>sample string 5</Normalcy>
    <Notes xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:NoteViewModel>
        <d3p1:Comments>sample string 1</d3p1:Comments>
        <d3p1:Format>sample string 2</d3p1:Format>
        <d3p1:NoteDateTime>2018-02-14T15:49:39.4939378-06:00</d3p1:NoteDateTime>
        <d3p1:Provider>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:Provider>
      </d3p1:NoteViewModel>
      <d3p1:NoteViewModel>
        <d3p1:Comments>sample string 1</d3p1:Comments>
        <d3p1:Format>sample string 2</d3p1:Format>
        <d3p1:NoteDateTime>2018-02-14T15:49:39.4939378-06:00</d3p1:NoteDateTime>
        <d3p1:Provider>
          <d3p1:ProviderId>sample string 1</d3p1:ProviderId>
          <d3p1:ProviderName>sample string 2</d3p1:ProviderName>
        </d3p1:Provider>
      </d3p1:NoteViewModel>
    </Notes>
    <OrderId>sample string 8</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-14T15:49:39.4939378-06:00</ResultDateTime>
    <ResultId>sample string 9</ResultId>
    <Status>sample string 10</Status>
    <Units>sample string 11</Units>
    <Value>sample string 12</Value>
  </PopulationLabResultResponseViewModel>
</ArrayOfPopulationLabResultResponseViewModel>

Submit a Comment

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

 

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