GET api/v1/{EMRSystem}/MicroResults

Returns Micro Results of all statuses for a given patient and filtered, optionally, by Order Id along with location and micro result details.

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.

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

UdmMicroResultsResponse
NameDescriptionTypeAdditional information
ResultDateTime

Gets or sets the result date time.

datetime

None.

ResultStatus

The status of the result.

CodedObject

None.

ClinicallySignificantUpdateDateTime

Gets or sets the clinically significant update date time.

datetime

None.

CollectedDateTime

Gets or sets the collected date time.

datetime

None.

ResultId

Gets or sets the result identifier.

string

None.

OrderId

Gets or sets the order identifier.

string

None.

MicroTestId

Gets or sets the micro test identifier.

string

None.

MicroTestDesc

Gets or sets the micro test desc.

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.

SpecimenSource

Gets or sets the specimen source.

string

None.

SpecimenType

Gets or sets the type of the specimen.

string

None.

AccessionNumber

Gets or sets the accession number.

string

None.

BodySite

Gets or sets the body site.

string

None.

MicroBiologies

Gets or sets the micro biologies.

Collection of MicroBiology

None.

MicroReports

Gets or sets the micro reports.

Collection of MicroReport

None.

CreatedUpdatedDateTime

Gets or sets the created updated date time.

datetime

None.

Patient

Gets or sets the patient.

BasePatient

None.

Encounter

Gets or sets the encounter.

Encounter

None.

OrderingProvider

Gets or sets the ordering provider.

Provider

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

{
  "ResultDateTime": "2025-12-12T21:06:26.3636005+00:00",
  "ResultStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "ClinicallySignificantUpdateDateTime": "2025-12-12T21:06:26.3637641+00:00",
  "CollectedDateTime": "2025-12-12T21:06:26.3638053+00:00",
  "ResultId": "sample string 1",
  "OrderId": "sample string 2",
  "MicroTestId": "sample string 3",
  "MicroTestDesc": "sample string 4",
  "Value": "sample string 5",
  "NormalHigh": "sample string 6",
  "NormalLow": "sample string 7",
  "Normalcy": "sample string 8",
  "SpecimenSource": "sample string 9",
  "SpecimenType": "sample string 10",
  "AccessionNumber": "sample string 11",
  "BodySite": "sample string 12",
  "MicroBiologies": [
    {
      "OrganismId": "sample string 1",
      "OrganismName": "sample string 2",
      "OrganismDesc": "sample string 3",
      "IsNoPrint": true,
      "IsReportable": true,
      "Comments": [
        {
          "Comments": "sample string 1",
          "NoteDateTime": "2025-12-12T21:06:26.3695112+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:06:26.3695112+00:00",
          "Format": "sample string 2",
          "IsEncoded": true,
          "Provider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NoteType": "sample string 4"
        }
      ],
      "Susceptibilities": [
        {
          "SusceptibilityTest": "sample string 1",
          "PanelAntibiotic": "sample string 2",
          "Antibiotic": "sample string 3",
          "AntibioticDesc": "sample string 4",
          "DilutionValue": "sample string 5",
          "DilutionUnit": "sample string 6",
          "SusceptibilityValue": "sample string 7",
          "SusceptibilityStatus": "sample string 8",
          "IsNoPrint": true,
          "IsReportable": true,
          "Result": {
            "CodedResult": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "Units": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "NumericResult": "sample string 1",
            "TextResult": "sample string 2",
            "ResultDateTime": "2025-12-12T21:06:26.3769341+00:00"
          }
        },
        {
          "SusceptibilityTest": "sample string 1",
          "PanelAntibiotic": "sample string 2",
          "Antibiotic": "sample string 3",
          "AntibioticDesc": "sample string 4",
          "DilutionValue": "sample string 5",
          "DilutionUnit": "sample string 6",
          "SusceptibilityValue": "sample string 7",
          "SusceptibilityStatus": "sample string 8",
          "IsNoPrint": true,
          "IsReportable": true,
          "Result": {
            "CodedResult": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "Units": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "NumericResult": "sample string 1",
            "TextResult": "sample string 2",
            "ResultDateTime": "2025-12-12T21:06:26.3769341+00:00"
          }
        }
      ]
    },
    {
      "OrganismId": "sample string 1",
      "OrganismName": "sample string 2",
      "OrganismDesc": "sample string 3",
      "IsNoPrint": true,
      "IsReportable": true,
      "Comments": [
        {
          "Comments": "sample string 1",
          "NoteDateTime": "2025-12-12T21:06:26.3695112+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:06:26.3695112+00:00",
          "Format": "sample string 2",
          "IsEncoded": true,
          "Provider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NoteType": "sample string 4"
        }
      ],
      "Susceptibilities": [
        {
          "SusceptibilityTest": "sample string 1",
          "PanelAntibiotic": "sample string 2",
          "Antibiotic": "sample string 3",
          "AntibioticDesc": "sample string 4",
          "DilutionValue": "sample string 5",
          "DilutionUnit": "sample string 6",
          "SusceptibilityValue": "sample string 7",
          "SusceptibilityStatus": "sample string 8",
          "IsNoPrint": true,
          "IsReportable": true,
          "Result": {
            "CodedResult": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "Units": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "NumericResult": "sample string 1",
            "TextResult": "sample string 2",
            "ResultDateTime": "2025-12-12T21:06:26.3769341+00:00"
          }
        },
        {
          "SusceptibilityTest": "sample string 1",
          "PanelAntibiotic": "sample string 2",
          "Antibiotic": "sample string 3",
          "AntibioticDesc": "sample string 4",
          "DilutionValue": "sample string 5",
          "DilutionUnit": "sample string 6",
          "SusceptibilityValue": "sample string 7",
          "SusceptibilityStatus": "sample string 8",
          "IsNoPrint": true,
          "IsReportable": true,
          "Result": {
            "CodedResult": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "Units": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            "NumericResult": "sample string 1",
            "TextResult": "sample string 2",
            "ResultDateTime": "2025-12-12T21:06:26.3769341+00:00"
          }
        }
      ]
    }
  ],
  "MicroReports": [
    {
      "ReportDateTime": "2025-12-12T21:06:26.3849691+00:00",
      "ComponentId": "sample string 1",
      "ComponentDesc": "sample string 2",
      "IsNoPrint": true,
      "IsReportable": true,
      "ReportStatus": "sample string 5",
      "VerifiedStatus": "sample string 6",
      "ReportContent": "sample string 7",
      "ReportContentExternal": "sample string 8",
      "Comments": [
        {
          "Comments": "sample string 1",
          "NoteDateTime": "2025-12-12T21:06:26.3695112+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:06:26.3695112+00:00",
          "Format": "sample string 2",
          "IsEncoded": true,
          "Provider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NoteType": "sample string 4"
        }
      ],
      "OrganismId": "sample string 9",
      "OrganismName": "sample string 10",
      "OrganismDesc": "sample string 11",
      "Organisms": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ]
    },
    {
      "ReportDateTime": "2025-12-12T21:06:26.3849691+00:00",
      "ComponentId": "sample string 1",
      "ComponentDesc": "sample string 2",
      "IsNoPrint": true,
      "IsReportable": true,
      "ReportStatus": "sample string 5",
      "VerifiedStatus": "sample string 6",
      "ReportContent": "sample string 7",
      "ReportContentExternal": "sample string 8",
      "Comments": [
        {
          "Comments": "sample string 1",
          "NoteDateTime": "2025-12-12T21:06:26.3695112+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:06:26.3695112+00:00",
          "Format": "sample string 2",
          "IsEncoded": true,
          "Provider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "NoteType": "sample string 4"
        }
      ],
      "OrganismId": "sample string 9",
      "OrganismName": "sample string 10",
      "OrganismDesc": "sample string 11",
      "Organisms": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ]
    }
  ],
  "CreatedUpdatedDateTime": "2025-12-12T21:06:26.3967137+00:00",
  "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:06:26.3967933+00:00",
    "Gender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "DeceasedDateTime": "2025-12-12T21:06:26.3967963+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:06:26.3968476+00:00",
    "DischargeDateTime": "2025-12-12T21:06:26.3968494+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"
    }
  },
  "OrderingProvider": {
    "ProviderId": "sample string 1",
    "ProviderName": "sample string 2"
  }
}

'

GET api/v1/{EMRSystem}/MicroResults

Returns Micro Results of all statuses for a given patient and filtered, optionally, by Order Id along with location and micro result details.

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}}