Skip to content
Hermes Health API
GuidesOpenAPI spec

Endpoints

Lab accessions

POST/v0/lab-accessions/browse

Browse lab accessions

Queries the lab accessions 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.labAccessionobject

    Which of the lab accession's columns to return.

  • select.labAccession.idboolean

    Platform identifier for the lab accession: a group of lab results ordered and reported together.

  • select.labAccession.sourceAccessionIdboolean

    Accession identifier assigned by the source laboratory or data provider. Multiple test results can share an accession.

  • select.labAccession.testDateboolean

    Test date reported for the parent laboratory accession.

  • select.labAccession.orderingFacilityClinumboolean

    Source-reported client number of the facility that ordered the tests. Blank when none was supplied.

  • select.labAccession.orderingFacilityNameboolean

    Name of the facility that ordered the tests. Blank when the source did not identify one.

  • select.labAccession.annotationboolean

    Source-supplied comments about the accession as a whole. Multiple comments are separated by line breaks. Blank when none were supplied.

  • select.labAccession.fcraDisputeboolean

    Source-reported Fair Credit Reporting Act (FCRA) dispute flag associated with the accession. Blank means no flag was supplied.

  • select.labAccession.dataSourceboolean
  • select.labAccession.createdAtboolean

    Timestamp when the accession was recorded in the platform. This is separate from the test date.

  • select.labAccession.companyIdboolean

    Platform identifier for the customer organization associated with the accession.

  • select.labAccession.projectIdboolean

    Platform identifier for the project containing the patient and accession.

  • select.labAccession.patientIdboolean

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

  • select.labAccession.orderingPhysicianSiteIdboolean

    Identifier of the site record for the physician who ordered the tests. Blank when the ordering physician could not be matched to a site.

  • 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.orderingPhysicianSiteobject & object

    Which of the joined ordering physician site's columns to return. Absent when the row has no ordering physician site.

  • whereobject
  • where.labAccessionobject

    Filters on the lab accession's columns.

  • where.labAccession.idobject | object | object | object | object | object | object | string[]

    Platform identifier for the lab accession: a group of lab results ordered and reported together.

  • where.labAccession.sourceAccessionIdobject | object | object | object | object | object | object | string[]

    Accession identifier assigned by the source laboratory or data provider. Multiple test results can share an accession.

  • where.labAccession.testDateobject | object | object | object | object | object | object | object | string[]

    Test date reported for the parent laboratory accession.

  • where.labAccession.orderingFacilityClinumobject | object | object | object | object | object | object | string[]

    Source-reported client number of the facility that ordered the tests. Blank when none was supplied.

  • where.labAccession.orderingFacilityNameobject | object | object | object | object | object | object | string[]

    Name of the facility that ordered the tests. Blank when the source did not identify one.

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

    Source-supplied comments about the accession as a whole. Multiple comments are separated by line breaks. Blank when none were supplied.

  • where.labAccession.fcraDisputeobject | object | object | object | string[]

    Source-reported Fair Credit Reporting Act (FCRA) dispute flag associated with the accession. Blank means no flag was supplied.

  • where.labAccession.dataSourceobject | object | object | object | object | object | object | string[]
  • where.labAccession.createdAtobject | object | object | object | object | object | object | object | string[]

    Timestamp when the accession was recorded in the platform. This is separate from the test date.

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

    Platform identifier for the customer organization associated with the accession.

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

    Platform identifier for the project containing the patient and accession.

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

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

  • where.labAccession.orderingPhysicianSiteIdobject | object | object | object | object | object | object | string[]

    Identifier of the site record for the physician who ordered the tests. Blank when the ordering physician could not be matched to a site.

  • 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.orderingPhysicianSitestring | object & object

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

  • aggregateobject
  • aggregate.labAccessionobject
  • aggregate.labAccession.countboolean

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

  • aggregate.labAccession.sumobject

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

  • aggregate.labAccession.avgobject

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

  • aggregate.labAccession.minobject

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

  • aggregate.labAccession.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.orderingPhysicianSiteobject & object
  • orderByobject | object | object | object | object[]
  • searchstring
  • takeinteger
  • skipinteger

ReturnsTyped browse response for LabAccessionBrowseResponse

Conditional attributes

  • tableobject[]
  • table[].labAccessionobject

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

  • table[].labAccession.idstring

    Platform identifier for the lab accession: a group of lab results ordered and reported together.

  • table[].labAccession.sourceAccessionIdstring

    Accession identifier assigned by the source laboratory or data provider. Multiple test results can share an accession.

  • table[].labAccession.testDatestring

    Test date reported for the parent laboratory accession.

  • table[].labAccession.orderingFacilityClinumstring

    Source-reported client number of the facility that ordered the tests. Blank when none was supplied.

  • table[].labAccession.orderingFacilityNamestring

    Name of the facility that ordered the tests. Blank when the source did not identify one.

  • table[].labAccession.annotationstring

    Source-supplied comments about the accession as a whole. Multiple comments are separated by line breaks. Blank when none were supplied.

  • table[].labAccession.fcraDisputeboolean

    Source-reported Fair Credit Reporting Act (FCRA) dispute flag associated with the accession. Blank means no flag was supplied.

  • table[].labAccession.dataSourcestring
  • table[].labAccession.createdAtstring

    Timestamp when the accession was recorded in the platform. This is separate from the test date.

  • table[].labAccession.companyIdinteger

    Platform identifier for the customer organization associated with the accession.

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

  • table[].labAccession.projectIdstring

    Platform identifier for the project containing the patient and accession.

  • table[].labAccession.patientIdstring

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

  • table[].labAccession.orderingPhysicianSiteIdstring

    Identifier of the site record for the physician who ordered the tests. Blank when the ordering physician could not be matched to a site.

  • 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[].orderingPhysicianSiteobject & object

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

  • aggregateobject
  • aggregate.labAccessionobject
  • aggregate.labAccession.countinteger

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

  • aggregate.labAccession.sumobject

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

  • aggregate.labAccession.avgobject

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

  • aggregate.labAccession.minobject

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

  • aggregate.labAccession.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.orderingPhysicianSiteobject & object
  • totalinteger

Errors

400401500