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. FHIR connectors use the following resources for R4: DiagnosticReport.Search, Patient.Read, Practitioner.Read, Encounter.Read, Observation.Read, Specimen.Read, ServiceRequest.Read, and Organization.Read.

Status: Released

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

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

datetime

None.
ToDateTime

Gets or sets to date.

datetime

None.

Header Parameters

NameDescriptionTypeAdditional 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 Result
NameDescriptionTypeAdditional information
DiagnosticReport

Gets or sets the diagnostic report identifier.

CodedObject

None.
ResultDateTime

Gets or sets the result date.

datetime

None.
ClinicallySignificantUpdateDateTime

Gets or sets the clinically significant update date time.

datetime

None.
CollectedDateTime

Gets or sets the specimen collected date time.

datetime

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.

CodedObject

None.
PatientClass

Gets or sets the patient class.

CodedObject

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 Note

None.
LOINC

Gets or sets the loinc.

string

None.
LabLocations

Gets or sets the lab locations.

Collection of LabLocation

None.
Status

Gets or sets the status.

string

None.
Flag

Gets or sets the flag.

string

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

[
  {
    "DiagnosticReport": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ResultDateTime": "2025-12-12T20:50:08.0099779+00:00",
    "ClinicallySignificantUpdateDateTime": "2025-12-12T20:50:08.0101507+00:00",
    "CollectedDateTime": "2025-12-12T20:50:08.0102047+00:00",
    "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": "2025-12-12T20:50:08.0110787+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-12T20:50:08.0110787+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "LOINC": "sample string 13",
    "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-12T20:50:08.0127006+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-12T20:50:08.0127006+00:00"
        },
        "Telephone": "sample string 3"
      }
    ],
    "Status": "sample string 14",
    "Flag": "sample string 15"
  },
  {
    "DiagnosticReport": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ResultDateTime": "2025-12-12T20:50:08.0099779+00:00",
    "ClinicallySignificantUpdateDateTime": "2025-12-12T20:50:08.0101507+00:00",
    "CollectedDateTime": "2025-12-12T20:50:08.0102047+00:00",
    "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": "2025-12-12T20:50:08.0110787+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-12T20:50:08.0110787+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "LOINC": "sample string 13",
    "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-12T20:50:08.0127006+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-12T20:50:08.0127006+00:00"
        },
        "Telephone": "sample string 3"
      }
    ],
    "Status": "sample string 14",
    "Flag": "sample string 15"
  }
]

'

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. FHIR connectors use the following resources for R4: DiagnosticReport.Search, Patient.Read, Practitioner.Read, Encounter.Read, Observation.Read, Specimen.Read, ServiceRequest.Read, and Organization.Read.

Status: Released

URI Parameters


Required
Required

Header Parameters

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

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

  • Http Request Headers
  • {{header.name}} : {{header.value}} ******
  • Http Request Body
  • {{httpRequestBody}}
  • Http Response Headers
  • {{header.name}} : {{header.value}} ******
  • Http Response Data
  • {{httpResponseData}}