GET Lab Results

Developer Tools

GET api/v1/{EMRSystem}/LabResults

Returns Lab Results of all statuses for a given patient and filtered, optionally, by Lab Order ID along with lab location and lab result details.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

Released

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

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

ResultId

Gets or sets the result identifier.

string

None

ComponentIdList

Gets or sets a comma delimitted list of component Id(s).

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
LabResultsResponseViewModel

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

ResultDateTime

Gets or sets the result date.

date

None.

ClinicallySignificantUpdateDateTime

Gets or sets the clinically significant update date time.

date

None.

CollectedDateTime

Gets or sets the specimen collected date time.

date

None.

OrderId

Gets or sets the order identifier.

string

None.

ResultId

Gets or sets the result identifier.

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.

User

Gets or sets the user.

string

None.

ComponentId

Gets or sets the component identifier.

string

None.

ComponentDesc

Gets or sets the component description.

string

None.

Value

Gets or sets the value.

string

None.

NormalHigh

Gets or sets the normal high.

string

None.

NormalLow

Gets or sets the normal low.

string

None.

Normalcy

Gets or sets the normalcy.

string

None.

Units

Gets or sets the units.

string

None.

Notes

Gets or sets the notes.

Collection of NoteViewModel

None.

LOINC

Gets or sets the loinc.

string

None.

LabLocations

Gets or sets the lab locations.

Collection of LabLocationViewModel

None.

Status

Gets or sets the status.

string

None.

Flag

Gets or sets the flag.

string

None.

 
Response Codes

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

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
[
  {
    "ResultDateTime": "2018-02-13T18:20:16.1898338Z",
    "ClinicallySignificantUpdateDateTime": "2018-02-13T18:20:16.1898338Z",
    "CollectedDateTime": "2018-02-13T18:20:16.1898338Z",
    "OrderId": "sample string 1",
    "ResultId": "sample string 2",
    "PatientId": "sample string 3",
    "EncounterId": "sample string 4",
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "User": "sample string 5",
    "ComponentId": "sample string 6",
    "ComponentDesc": "sample string 7",
    "Value": "sample string 8",
    "NormalHigh": "sample string 9",
    "NormalLow": "sample string 10",
    "Normalcy": "sample string 11",
    "Units": "sample string 12",
    "Notes": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-13T18:20:16.1898338Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-13T18:20:16.1898338Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      }
    ],
    "LOINC": "sample string 13",
    "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"
      }
    ],
    "Status": "sample string 14",
    "Flag": "sample string 15"
  },
  {
    "ResultDateTime": "2018-02-13T18:20:16.1898338Z",
    "ClinicallySignificantUpdateDateTime": "2018-02-13T18:20:16.1898338Z",
    "CollectedDateTime": "2018-02-13T18:20:16.1898338Z",
    "OrderId": "sample string 1",
    "ResultId": "sample string 2",
    "PatientId": "sample string 3",
    "EncounterId": "sample string 4",
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "User": "sample string 5",
    "ComponentId": "sample string 6",
    "ComponentDesc": "sample string 7",
    "Value": "sample string 8",
    "NormalHigh": "sample string 9",
    "NormalLow": "sample string 10",
    "Normalcy": "sample string 11",
    "Units": "sample string 12",
    "Notes": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-13T18:20:16.1898338Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2018-02-13T18:20:16.1898338Z",
        "Format": "sample string 2",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        }
      }
    ],
    "LOINC": "sample string 13",
    "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"
      }
    ],
    "Status": "sample string 14",
    "Flag": "sample string 15"
  }
]
Sample Message
<ArrayOfResultViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <ResultViewModel>
    <ClinicallySignificantUpdateDateTime>2018-02-13T12:20:16.1898338-06:00</ClinicallySignificantUpdateDateTime>
    <CollectedDateTime>2018-02-13T12:20:16.1898338-06:00</CollectedDateTime>
    <ComponentDesc>sample string 7</ComponentDesc>
    <ComponentId>sample string 6</ComponentId>
    <EncounterId>sample string 4</EncounterId>
    <EncounterType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </EncounterType>
    <Flag>sample string 15</Flag>
    <LOINC>sample string 13</LOINC>
    <LabLocations>
      <LabLocationViewModel>
        <Address>
          <Address1>sample string 2</Address1>
          <Address2>sample string 3</Address2>
          <AddressId>sample string 1</AddressId>
          <City>sample string 4</City>
          <Country>sample string 8</Country>
          <State>sample string 5</State>
          <Type>sample string 7</Type>
          <ZIP>sample string 6</ZIP>
        </Address>
        <LabName>sample string 1</LabName>
        <Telephone>sample string 2</Telephone>
      </LabLocationViewModel>
      <LabLocationViewModel>
        <Address>
          <Address1>sample string 2</Address1>
          <Address2>sample string 3</Address2>
          <AddressId>sample string 1</AddressId>
          <City>sample string 4</City>
          <Country>sample string 8</Country>
          <State>sample string 5</State>
          <Type>sample string 7</Type>
          <ZIP>sample string 6</ZIP>
        </Address>
        <LabName>sample string 1</LabName>
        <Telephone>sample string 2</Telephone>
      </LabLocationViewModel>
    </LabLocations>
    <NormalHigh>sample string 9</NormalHigh>
    <NormalLow>sample string 10</NormalLow>
    <Normalcy>sample string 11</Normalcy>
    <Notes>
      <NoteViewModel>
        <Comments>sample string 1</Comments>
        <Format>sample string 2</Format>
        <NoteDateTime>2018-02-13T12:20:16.1898338-06:00</NoteDateTime>
        <Provider>
          <ProviderId>sample string 1</ProviderId>
          <ProviderName>sample string 2</ProviderName>
        </Provider>
      </NoteViewModel>
      <NoteViewModel>
        <Comments>sample string 1</Comments>
        <Format>sample string 2</Format>
        <NoteDateTime>2018-02-13T12:20:16.1898338-06:00</NoteDateTime>
        <Provider>
          <ProviderId>sample string 1</ProviderId>
          <ProviderName>sample string 2</ProviderName>
        </Provider>
      </NoteViewModel>
    </Notes>
    <OrderId>sample string 1</OrderId>
    <PatientClass>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PatientClass>
    <PatientId>sample string 3</PatientId>
    <ResultDateTime>2018-02-13T12:20:16.1898338-06:00</ResultDateTime>
    <ResultId>sample string 2</ResultId>
    <Status>sample string 14</Status>
    <Units>sample string 12</Units>
    <User>sample string 5</User>
    <Value>sample string 8</Value>
  </ResultViewModel>
  <ResultViewModel>
    <ClinicallySignificantUpdateDateTime>2018-02-13T12:20:16.1898338-06:00</ClinicallySignificantUpdateDateTime>
    <CollectedDateTime>2018-02-13T12:20:16.1898338-06:00</CollectedDateTime>
    <ComponentDesc>sample string 7</ComponentDesc>
    <ComponentId>sample string 6</ComponentId>
    <EncounterId>sample string 4</EncounterId>
    <EncounterType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </EncounterType>
    <Flag>sample string 15</Flag>
    <LOINC>sample string 13</LOINC>
    <LabLocations>
      <LabLocationViewModel>
        <Address>
          <Address1>sample string 2</Address1>
          <Address2>sample string 3</Address2>
          <AddressId>sample string 1</AddressId>
          <City>sample string 4</City>
          <Country>sample string 8</Country>
          <State>sample string 5</State>
          <Type>sample string 7</Type>
          <ZIP>sample string 6</ZIP>
        </Address>
        <LabName>sample string 1</LabName>
        <Telephone>sample string 2</Telephone>
      </LabLocationViewModel>
      <LabLocationViewModel>
        <Address>
          <Address1>sample string 2</Address1>
          <Address2>sample string 3</Address2>
          <AddressId>sample string 1</AddressId>
          <City>sample string 4</City>
          <Country>sample string 8</Country>
          <State>sample string 5</State>
          <Type>sample string 7</Type>
          <ZIP>sample string 6</ZIP>
        </Address>
        <LabName>sample string 1</LabName>
        <Telephone>sample string 2</Telephone>
      </LabLocationViewModel>
    </LabLocations>
    <NormalHigh>sample string 9</NormalHigh>
    <NormalLow>sample string 10</NormalLow>
    <Normalcy>sample string 11</Normalcy>
    <Notes>
      <NoteViewModel>
        <Comments>sample string 1</Comments>
        <Format>sample string 2</Format>
        <NoteDateTime>2018-02-13T12:20:16.1898338-06:00</NoteDateTime>
        <Provider>
          <ProviderId>sample string 1</ProviderId>
          <ProviderName>sample string 2</ProviderName>
        </Provider>
      </NoteViewModel>
      <NoteViewModel>
        <Comments>sample string 1</Comments>
        <Format>sample string 2</Format>
        <NoteDateTime>2018-02-13T12:20:16.1898338-06:00</NoteDateTime>
        <Provider>
          <ProviderId>sample string 1</ProviderId>
          <ProviderName>sample string 2</ProviderName>
        </Provider>
      </NoteViewModel>
    </Notes>
    <OrderId>sample string 1</OrderId>
    <PatientClass>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PatientClass>
    <PatientId>sample string 3</PatientId>
    <ResultDateTime>2018-02-13T12:20:16.1898338-06:00</ResultDateTime>
    <ResultId>sample string 2</ResultId>
    <Status>sample string 14</Status>
    <Units>sample string 12</Units>
    <User>sample string 5</User>
    <Value>sample string 8</Value>
  </ResultViewModel>
</ArrayOfResultViewModel>

Submit a Comment

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

 

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