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).

Status: Released

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
ComponentIdList	Gets or sets the component identifier list (comma delimitted).	string	None.
LocationList	Gets or sets the location list.	string	None.
UserId	Identifier of the user initiating the request.	string	Required
FromDateTime	Gets or sets from date time.	datetime	Required if EMRSystem = Cerner, or Epic, or Meditech
ToDateTime	Gets or sets to date time.	datetime	None.

Header Parameters

Name	Description	Type	Additional information
LoginId	Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password	Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance	Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
ApplicationName	Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if using application keys
ApplicationKey	Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if using application keys
AuthorizationToken	Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
RequestVerboseLogging	Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.	boolean	None.

Response Information

Collection of UdmPopulationLabResultResponse

Name	Description	Type	Additional information
ClinicallySignificantUpdateDateTime	Gets the clinically significant update date time.	datetime	None.
CollectedDateTime	Gets the collected date time.	datetime	None.
ComponentDesc	Gets the component desc.	string	None.
ComponentId	Gets the component identifier.	string	None.
CreatedUpdatedDateTime	Gets or sets the created updated date time.	datetime	None.
Encounter	Gets the encounter.	Encounter	None.
Flag	Gets the flag.	string	None.
IsReportable	Gets the IsReportable flag.	boolean	None.
LabLocations	Gets the lab locations.	Collection of LabLocation	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 Note	None.
OrderId	Gets the order identifier.	string	None.
OrderCatalog	Gets the order catalog code	CodedObject	None.
OrderDescription	Gets the order description from the orders.ordered_as_mnemonic	string	None.
Patient	Gets the patient.	BasePatient	None.
ResultDateTime	Gets the result date time.	datetime	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.	Provider	None.
DiagnosticReport	Gets or sets the diagnostic report identifier and name	CodedObject	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

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

application/json

[
  {
    "ClinicallySignificantUpdateDateTime": "2025-12-12T21:05:09.9701398+00:00",
    "CollectedDateTime": "2025-12-12T21:05:09.9702379+00:00",
    "ComponentDesc": "sample string 1",
    "ComponentId": "sample string 2",
    "CreatedUpdatedDateTime": "2025-12-12T21:05:09.9710545+00:00",
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2025-12-12T21:05:09.9711293+00:00",
      "DischargeDateTime": "2025-12-12T21:05:09.9711311+00:00",
      "FinancialNumber": "sample string 2",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      }
    },
    "Flag": "sample string 3",
    "IsReportable": true,
    "LabLocations": [
      {
        "LabId": "sample string 1",
        "LabName": "sample string 2",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "Address3": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "ZIP": "sample string 7",
          "Type": "sample string 8",
          "TypeId": "sample string 9",
          "SequenceNumber": "sample string 10",
          "Country": "sample string 11",
          "County": "sample string 12",
          "EndEffectiveDateTime": "2025-12-12T21:05:09.9715528+00:00"
        },
        "Telephone": "sample string 3"
      },
      {
        "LabId": "sample string 1",
        "LabName": "sample string 2",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "Address3": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "ZIP": "sample string 7",
          "Type": "sample string 8",
          "TypeId": "sample string 9",
          "SequenceNumber": "sample string 10",
          "Country": "sample string 11",
          "County": "sample string 12",
          "EndEffectiveDateTime": "2025-12-12T21:05:09.9715528+00:00"
        },
        "Telephone": "sample string 3"
      }
    ],
    "LOINC": "sample string 5",
    "Normalcy": "sample string 6",
    "NormalHigh": "sample string 7",
    "NormalLow": "sample string 8",
    "Notes": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T21:05:09.9719838+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T21:05:09.9719838+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "OrderId": "sample string 9",
    "OrderCatalog": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "OrderDescription": "sample string 10",
    "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": "2025-12-12T21:05:09.972171+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T21:05:09.9721744+00:00"
    },
    "ResultDateTime": "2025-12-12T21:05:09.9722062+00:00",
    "ResultId": "sample string 11",
    "Status": "sample string 12",
    "Units": "sample string 13",
    "Value": "sample string 14",
    "OrderingProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "DiagnosticReport": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  },
  {
    "ClinicallySignificantUpdateDateTime": "2025-12-12T21:05:09.9701398+00:00",
    "CollectedDateTime": "2025-12-12T21:05:09.9702379+00:00",
    "ComponentDesc": "sample string 1",
    "ComponentId": "sample string 2",
    "CreatedUpdatedDateTime": "2025-12-12T21:05:09.9710545+00:00",
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2025-12-12T21:05:09.9711293+00:00",
      "DischargeDateTime": "2025-12-12T21:05:09.9711311+00:00",
      "FinancialNumber": "sample string 2",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      }
    },
    "Flag": "sample string 3",
    "IsReportable": true,
    "LabLocations": [
      {
        "LabId": "sample string 1",
        "LabName": "sample string 2",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "Address3": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "ZIP": "sample string 7",
          "Type": "sample string 8",
          "TypeId": "sample string 9",
          "SequenceNumber": "sample string 10",
          "Country": "sample string 11",
          "County": "sample string 12",
          "EndEffectiveDateTime": "2025-12-12T21:05:09.9715528+00:00"
        },
        "Telephone": "sample string 3"
      },
      {
        "LabId": "sample string 1",
        "LabName": "sample string 2",
        "Address": {
          "AddressId": "sample string 1",
          "Address1": "sample string 2",
          "Address2": "sample string 3",
          "Address3": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "ZIP": "sample string 7",
          "Type": "sample string 8",
          "TypeId": "sample string 9",
          "SequenceNumber": "sample string 10",
          "Country": "sample string 11",
          "County": "sample string 12",
          "EndEffectiveDateTime": "2025-12-12T21:05:09.9715528+00:00"
        },
        "Telephone": "sample string 3"
      }
    ],
    "LOINC": "sample string 5",
    "Normalcy": "sample string 6",
    "NormalHigh": "sample string 7",
    "NormalLow": "sample string 8",
    "Notes": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T21:05:09.9719838+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T21:05:09.9719838+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "OrderId": "sample string 9",
    "OrderCatalog": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "OrderDescription": "sample string 10",
    "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": "2025-12-12T21:05:09.972171+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T21:05:09.9721744+00:00"
    },
    "ResultDateTime": "2025-12-12T21:05:09.9722062+00:00",
    "ResultId": "sample string 11",
    "Status": "sample string 12",
    "Units": "sample string 13",
    "Value": "sample string 14",
    "OrderingProvider": {
      "ProviderId": "sample string 1",
      "ProviderName": "sample string 2"
    },
    "DiagnosticReport": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  }
]

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).

Status: Released

URI Parameters

EMRSystem

Required

ComponentIdList

LocationList

UserId

Required

FromDateTime

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```