Skip to content
Hermes Health API
GuidesOpenAPI spec

Endpoints

Lab results

POST/v0/lab-results/browse

Browse lab results

Queries the lab results on the patients visible to the caller. Read-only. Uses the shared browse syntax described in Browsing tables and returns the { table, aggregate, total } envelope as JSON, or the selected columns as CSV when you send Accept: text/csv. Until clinical data has finished loading after a service restart, the call returns 500 rather than an empty table; retry shortly.

Request bodyapplication/json

Optional parameters

  • selectobject
  • select.labResultobject

    Which of the lab result's columns to return.

  • select.labResult.refboolean
  • select.labResult.testCodeboolean

    Source test identifier or test name. This field is not guaranteed to be a LOINC code.

  • select.labResult.providerTestCodeboolean

    Provider-supplied laboratory test code, commonly a LOINC code when supplied by the source.

  • select.labResult.batteryEventGroupNameboolean

    Name of the laboratory panel or battery grouping the test result.

  • select.labResult.batteryEventTestNameboolean

    Source-reported name of the test within a laboratory panel or battery.

  • select.labResult.interpretationboolean

    Source-reported interpretation flag. XLSX values are normal, high, low, abnormal, or other. The flag is supplied with the data rather than recalculated from the reference range.

  • select.labResult.performingSiteKindboolean

    Type of performing laboratory reported by the source. XLSX values are clinical or riskAssessment.

  • select.labResult.qualitativeResultboolean

    Textual laboratory result, such as Positive, Negative, or Trace, when reported.

  • select.labResult.quantitativeResultboolean

    Numeric laboratory result. Interpret together with unitsOfMeasure and the source-provided reference range.

  • select.labResult.unitsOfMeasureboolean

    Units associated with the numeric laboratory result, as reported by the source.

  • select.labResult.referenceMinboolean

    Lower bound of the source-reported reference range. Interpret using referenceUnits. This XLSX field is separate from referenceMax.

  • select.labResult.referenceMaxboolean

    Upper bound of the source-reported reference range. Interpret using referenceUnits.

  • select.labResult.referenceUnitsboolean

    Units associated with the source-reported reference range. These may differ from the result units.

  • select.labResult.scoreboolean

    Source-supplied score associated with this lab result. No universal scoring scale is defined.

  • select.labResult.annotationboolean

    Additional source-supplied comments about the lab result. Multiple annotations may be separated by line breaks.

  • select.labResult.createdAtboolean

    Timestamp when the lab-result data was recorded in the platform. This is separate from the accession test date.

  • select.labResult.companyIdboolean

    Platform identifier for the customer organization associated with the record.

  • select.labResult.projectIdboolean

    Platform identifier for the project containing the patient and record.

  • select.labResult.patientIdboolean

    Platform identifier for the patient associated with the record. Use with the company and project identifiers to identify the patient scope.

  • select.labResult.labAccessionIdboolean
  • select.loincobject & object

    Which of the joined loinc's columns to return. Absent when the row has no loinc.

  • select.companyobject & object

    Which of the joined company's columns to return. Absent when the row has no company.

  • select.projectobject & object

    Which of the joined project's columns to return. Absent when the row has no project.

  • select.patientobject & object

    Which of the joined patient's columns to return. Absent when the row has no patient.

  • select.labAccessionobject & object

    Which of the joined lab accession's columns to return. Absent when the row has no lab accession.

  • whereobject
  • where.labResultobject

    Filters on the lab result's columns.

  • where.labResult.refobject | object | object | object | object | object | object | string[]
  • where.labResult.testCodeobject | object | object | object | object | object | object | string[]

    Source test identifier or test name. This field is not guaranteed to be a LOINC code.

  • where.labResult.providerTestCodeobject | object | object | object | object | object | object | string[]

    Provider-supplied laboratory test code, commonly a LOINC code when supplied by the source.

  • where.labResult.batteryEventGroupNameobject | object | object | object | object | object | object | string[]

    Name of the laboratory panel or battery grouping the test result.

  • where.labResult.batteryEventTestNameobject | object | object | object | object | object | object | string[]

    Source-reported name of the test within a laboratory panel or battery.

  • where.labResult.interpretationobject | object | object | object | string[]

    Source-reported interpretation flag. XLSX values are normal, high, low, abnormal, or other. The flag is supplied with the data rather than recalculated from the reference range.

  • where.labResult.performingSiteKindobject | object | object | object | string[]

    Type of performing laboratory reported by the source. XLSX values are clinical or riskAssessment.

  • where.labResult.qualitativeResultobject | object | object | object | object | object | object | string[]

    Textual laboratory result, such as Positive, Negative, or Trace, when reported.

  • where.labResult.quantitativeResultobject | object | object | object | object | object | object | object | string[]

    Numeric laboratory result. Interpret together with unitsOfMeasure and the source-provided reference range.

  • where.labResult.unitsOfMeasureobject | object | object | object | object | object | object | string[]

    Units associated with the numeric laboratory result, as reported by the source.

  • where.labResult.referenceMinobject | object | object | object | object | object | object | object | string[]

    Lower bound of the source-reported reference range. Interpret using referenceUnits. This XLSX field is separate from referenceMax.

  • where.labResult.referenceMaxobject | object | object | object | object | object | object | object | string[]

    Upper bound of the source-reported reference range. Interpret using referenceUnits.

  • where.labResult.referenceUnitsobject | object | object | object | object | object | object | string[]

    Units associated with the source-reported reference range. These may differ from the result units.

  • where.labResult.scoreobject | object | object | object | object | object | object | object | string[]

    Source-supplied score associated with this lab result. No universal scoring scale is defined.

  • where.labResult.annotationobject | object | object | object | object | object | object | string[]

    Additional source-supplied comments about the lab result. Multiple annotations may be separated by line breaks.

  • where.labResult.createdAtobject | object | object | object | object | object | object | object | string[]

    Timestamp when the lab-result data was recorded in the platform. This is separate from the accession test date.

  • where.labResult.companyIdobject | object | object | object | object | object | object | object | string[]

    Platform identifier for the customer organization associated with the record.

  • where.labResult.projectIdobject | object | object | object | object | object | object | string[]

    Platform identifier for the project containing the patient and record.

  • where.labResult.patientIdobject | object | object | object | object | object | object | string[]

    Platform identifier for the patient associated with the record. Use with the company and project identifiers to identify the patient scope.

  • where.labResult.labAccessionIdobject | object | object | object | object | object | object | string[]
  • where.companystring | object & object

    Filters on the joined company's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a company.

  • where.projectstring | object & object

    Filters on the joined project's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a project.

  • where.patientstring | object & object

    Filters on the joined patient's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a patient.

  • where.labAccessionstring | object & object

    Filters on the joined lab accession's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a lab accession.

  • aggregateobject
  • aggregate.labResultobject
  • aggregate.labResult.countboolean

    When true, return the number of rows that match the filter.

  • aggregate.labResult.sumobject

    Numeric columns to total across the rows that match the filter.

  • aggregate.labResult.avgobject

    Numeric columns to average across the rows that match the filter.

  • aggregate.labResult.minobject

    Numeric columns to find the smallest value of across the rows that match the filter.

  • aggregate.labResult.maxobject

    Numeric columns to find the largest value of across the rows that match the filter.

  • aggregate.companyobject & object
  • aggregate.projectobject & object
  • aggregate.patientobject & object
  • aggregate.labAccessionobject & object
  • orderByobject | object | object | object | object[]
  • searchstring
  • takeinteger
  • skipinteger

ReturnsTyped browse response for LabResultBrowseResponse

Conditional attributes

  • tableobject[]
  • table[].labResultobject

    The lab result's columns, as selected by the request.

  • table[].labResult.refstring
  • table[].labResult.idstringDeprecated

    Legacy alias of `ref`; prefer `ref`.

  • table[].labResult.testCodestring

    Source test identifier or test name. This field is not guaranteed to be a LOINC code.

  • table[].labResult.providerTestCodestring

    Provider-supplied laboratory test code, commonly a LOINC code when supplied by the source.

  • table[].labResult.batteryEventGroupNamestring

    Name of the laboratory panel or battery grouping the test result.

  • table[].labResult.batteryEventTestNamestring

    Source-reported name of the test within a laboratory panel or battery.

  • table[].labResult.interpretationstring

    Source-reported interpretation flag. XLSX values are normal, high, low, abnormal, or other. The flag is supplied with the data rather than recalculated from the reference range.

  • table[].labResult.performingSiteKindstring

    Type of performing laboratory reported by the source. XLSX values are clinical or riskAssessment.

  • table[].labResult.qualitativeResultstring

    Textual laboratory result, such as Positive, Negative, or Trace, when reported.

  • table[].labResult.quantitativeResultstring

    Numeric laboratory result. Interpret together with unitsOfMeasure and the source-provided reference range.

  • table[].labResult.unitsOfMeasurestring

    Units associated with the numeric laboratory result, as reported by the source.

  • table[].labResult.referenceMinstring

    Lower bound of the source-reported reference range. Interpret using referenceUnits. This XLSX field is separate from referenceMax.

  • table[].labResult.referenceMaxstring

    Upper bound of the source-reported reference range. Interpret using referenceUnits.

  • table[].labResult.referenceUnitsstring

    Units associated with the source-reported reference range. These may differ from the result units.

  • table[].labResult.scoreinteger

    Source-supplied score associated with this lab result. No universal scoring scale is defined.

  • table[].labResult.annotationstring

    Additional source-supplied comments about the lab result. Multiple annotations may be separated by line breaks.

  • table[].labResult.createdAtstring

    Timestamp when the lab-result data was recorded in the platform. This is separate from the accession test date.

  • table[].labResult.companyIdinteger

    Platform identifier for the customer organization associated with the record.

    The numeric id of the company (tenant) a resource belongs to.

  • table[].labResult.projectIdstring

    Platform identifier for the project containing the patient and record.

  • table[].labResult.patientIdstring

    Platform identifier for the patient associated with the record. Use with the company and project identifiers to identify the patient scope.

  • table[].labResult.labAccessionIdstring
  • table[].loincobject & object

    The joined loinc's columns, as selected by the request. Absent when the row has no loinc.

  • table[].companyobject & object & object & object

    The joined company's columns, as selected by the request. Absent when the row has no company.

  • table[].projectobject & object & object

    The joined project's columns, as selected by the request. Absent when the row has no project.

  • table[].patientobject & object & object

    The joined patient's columns, as selected by the request. Absent when the row has no patient.

  • table[].labAccessionobject & object

    The joined lab accession's columns, as selected by the request. Absent when the row has no lab accession.

  • aggregateobject
  • aggregate.labResultobject
  • aggregate.labResult.countinteger

    Number of rows that match the filter. Present when `count` was requested.

  • aggregate.labResult.sumobject

    Total of each requested numeric column across the rows that match the filter.

  • aggregate.labResult.avgobject

    Average of each requested numeric column across the rows that match the filter.

  • aggregate.labResult.minobject

    Smallest value of each requested numeric column across the rows that match the filter.

  • aggregate.labResult.maxobject

    Largest value of each requested numeric column across the rows that match the filter.

  • aggregate.companyobject & object
  • aggregate.projectobject & object
  • aggregate.patientobject & object
  • aggregate.labAccessionobject & object
  • totalinteger

Errors

400401500