GET api/v1/{EMRSystem}/LabOrders

Returns Lab Orders of all statuses for a given patient along with lab location and lab component details. FHIR connectors use the following resources for R4: ServiceRequests.Search and Specimen.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
UserType

Gets or sets the type of the user.

UserType

None.
EncounterId

Gets or sets the encounter identifier.

string

None.
OrderId

Gets or sets the id of the order.

string

None.
OrderType

Gets or sets the type of the order.

string

None.
DateQueryType

Gets or sets the type of the date.

DateQueryType

None.
FromDateTime

Gets or sets from date.

datetime

None.
ToDateTime

Gets or sets to date.

datetime

None.
IncludeResults

Gets or sets a value indicating whether [include results].

boolean

None.
IncludeAudit

Gets or sets a value indicating whether [include audit].

boolean

None.
MaxRecords

Gets or sets the maximum records. If not set, defaulted to 9999

integer

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

UdmLabOrdersResponse
NameDescriptionTypeAdditional information
LabOrders

Gets or sets the lab orders.

Collection of LabOrder

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

{
  "LabOrders": [
    {
      "PatientId": "sample string 1",
      "EncounterId": "sample string 2",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "OrderId": "sample string 3",
      "AccessionNumber": "sample string 4",
      "SpecimenType": "sample string 5",
      "OrderStatus": "sample string 6",
      "OrderDesc": "sample string 7",
      "OrderedDateTime": "2025-12-12T20:56:00.3409708+00:00",
      "CollectedDateTime": "2025-12-12T20:56:00.3410618+00:00",
      "OrderedBy": "sample string 8",
      "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:56:00.3417513+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:56:00.3417513+00:00"
          },
          "Telephone": "sample string 3"
        }
      ],
      "Audits": [
        {
          "AuditDateTime": "2025-12-12T20:56:00.3421443+00:00",
          "User": "sample string 1",
          "Action": "sample string 2",
          "Status": "sample string 3"
        },
        {
          "AuditDateTime": "2025-12-12T20:56:00.3421443+00:00",
          "User": "sample string 1",
          "Action": "sample string 2",
          "Status": "sample string 3"
        }
      ],
      "Components": [
        {
          "SequenceNumber": "sample string 1",
          "ResultDateTime": "2025-12-12T20:56:00.3426246+00:00",
          "ClinicallySignificantUpdateDateTime": "2025-12-12T20:56:00.3426679+00:00",
          "CollectedDateTime": "2025-12-12T20:56:00.3427037+00:00",
          "ResultId": "sample string 2",
          "ResultValue": "sample string 3",
          "ComponentId": "sample string 4",
          "ComponentDesc": "sample string 5",
          "NormalLow": "sample string 6",
          "NormalHigh": "sample string 7",
          "Units": "sample string 8",
          "Normalcy": "sample string 9",
          "Flag": "sample string 10",
          "Status": "sample string 11",
          "Notes": [
            {
              "Comments": "sample string 1",
              "NoteDateTime": "2025-12-12T20:56:00.3431678+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:56:00.3431678+00:00",
              "Format": "sample string 2",
              "IsEncoded": true,
              "Provider": {
                "ProviderId": "sample string 1",
                "ProviderName": "sample string 2"
              },
              "NoteType": "sample string 4"
            }
          ],
          "LOINC": "sample string 12",
          "DiagnosticReport": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "SequenceNumber": "sample string 1",
          "ResultDateTime": "2025-12-12T20:56:00.3426246+00:00",
          "ClinicallySignificantUpdateDateTime": "2025-12-12T20:56:00.3426679+00:00",
          "CollectedDateTime": "2025-12-12T20:56:00.3427037+00:00",
          "ResultId": "sample string 2",
          "ResultValue": "sample string 3",
          "ComponentId": "sample string 4",
          "ComponentDesc": "sample string 5",
          "NormalLow": "sample string 6",
          "NormalHigh": "sample string 7",
          "Units": "sample string 8",
          "Normalcy": "sample string 9",
          "Flag": "sample string 10",
          "Status": "sample string 11",
          "Notes": [
            {
              "Comments": "sample string 1",
              "NoteDateTime": "2025-12-12T20:56:00.3431678+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:56:00.3431678+00:00",
              "Format": "sample string 2",
              "IsEncoded": true,
              "Provider": {
                "ProviderId": "sample string 1",
                "ProviderName": "sample string 2"
              },
              "NoteType": "sample string 4"
            }
          ],
          "LOINC": "sample string 12",
          "DiagnosticReport": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "ParentOrderId": "sample string 9",
      "IsNurseReviewed": true
    },
    {
      "PatientId": "sample string 1",
      "EncounterId": "sample string 2",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "OrderId": "sample string 3",
      "AccessionNumber": "sample string 4",
      "SpecimenType": "sample string 5",
      "OrderStatus": "sample string 6",
      "OrderDesc": "sample string 7",
      "OrderedDateTime": "2025-12-12T20:56:00.3409708+00:00",
      "CollectedDateTime": "2025-12-12T20:56:00.3410618+00:00",
      "OrderedBy": "sample string 8",
      "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:56:00.3417513+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:56:00.3417513+00:00"
          },
          "Telephone": "sample string 3"
        }
      ],
      "Audits": [
        {
          "AuditDateTime": "2025-12-12T20:56:00.3421443+00:00",
          "User": "sample string 1",
          "Action": "sample string 2",
          "Status": "sample string 3"
        },
        {
          "AuditDateTime": "2025-12-12T20:56:00.3421443+00:00",
          "User": "sample string 1",
          "Action": "sample string 2",
          "Status": "sample string 3"
        }
      ],
      "Components": [
        {
          "SequenceNumber": "sample string 1",
          "ResultDateTime": "2025-12-12T20:56:00.3426246+00:00",
          "ClinicallySignificantUpdateDateTime": "2025-12-12T20:56:00.3426679+00:00",
          "CollectedDateTime": "2025-12-12T20:56:00.3427037+00:00",
          "ResultId": "sample string 2",
          "ResultValue": "sample string 3",
          "ComponentId": "sample string 4",
          "ComponentDesc": "sample string 5",
          "NormalLow": "sample string 6",
          "NormalHigh": "sample string 7",
          "Units": "sample string 8",
          "Normalcy": "sample string 9",
          "Flag": "sample string 10",
          "Status": "sample string 11",
          "Notes": [
            {
              "Comments": "sample string 1",
              "NoteDateTime": "2025-12-12T20:56:00.3431678+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:56:00.3431678+00:00",
              "Format": "sample string 2",
              "IsEncoded": true,
              "Provider": {
                "ProviderId": "sample string 1",
                "ProviderName": "sample string 2"
              },
              "NoteType": "sample string 4"
            }
          ],
          "LOINC": "sample string 12",
          "DiagnosticReport": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "SequenceNumber": "sample string 1",
          "ResultDateTime": "2025-12-12T20:56:00.3426246+00:00",
          "ClinicallySignificantUpdateDateTime": "2025-12-12T20:56:00.3426679+00:00",
          "CollectedDateTime": "2025-12-12T20:56:00.3427037+00:00",
          "ResultId": "sample string 2",
          "ResultValue": "sample string 3",
          "ComponentId": "sample string 4",
          "ComponentDesc": "sample string 5",
          "NormalLow": "sample string 6",
          "NormalHigh": "sample string 7",
          "Units": "sample string 8",
          "Normalcy": "sample string 9",
          "Flag": "sample string 10",
          "Status": "sample string 11",
          "Notes": [
            {
              "Comments": "sample string 1",
              "NoteDateTime": "2025-12-12T20:56:00.3431678+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:56:00.3431678+00:00",
              "Format": "sample string 2",
              "IsEncoded": true,
              "Provider": {
                "ProviderId": "sample string 1",
                "ProviderName": "sample string 2"
              },
              "NoteType": "sample string 4"
            }
          ],
          "LOINC": "sample string 12",
          "DiagnosticReport": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "ParentOrderId": "sample string 9",
      "IsNurseReviewed": true
    }
  ]
}

'

GET api/v1/{EMRSystem}/LabOrders

Returns Lab Orders of all statuses for a given patient along with lab location and lab component details. FHIR connectors use the following resources for R4: ServiceRequests.Search and Specimen.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}}