Skip to content
Hermes Health API
GuidesOpenAPI spec

Endpoints

Visits

POST/v0/visits/browse

Browse visits

Queries the visits 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.visitobject

    Which of the visit's columns to return.

  • select.visit.refboolean

    Reference for the visit in the current data output. This reference can change when data is reprocessed and should not be used as a permanent identifier.

  • select.visit.encounterTypeboolean

    Source-reported encounter category, such as inpatient or outpatient. Values depend on the contributing source and are not a fixed enumerated list.

  • select.visit.claimTypeboolean

    Source-reported numeric claim-type code. Source-specific and may be blank.

  • select.visit.earliestServiceDateboolean

    Earliest service date reported for the visit. This describes the care event, not the date of the search.

  • select.visit.latestServiceDateboolean

    Latest service date reported for the visit. It may equal the earliest service date for a single-day encounter.

  • select.visit.memberIdboolean

    Insurance member identifier reported in the source claims data. Preserve as text, including any leading zeros.

  • select.visit.createdAtboolean

    Timestamp associated with the visit data in the platform. For merged visits, this is the newest contributing data timestamp and can change when newer data contributes.

  • select.visit.dataSourcesboolean
  • select.visit.ehrDiscoveredboolean

    Whether an electronic health record discovery source contributed to this visit. A true value indicates EHR discovery, subject to the account permissions needed to request records.

  • select.visit.companyIdboolean

    Platform identifier for the customer organization associated with the record.

  • select.visit.projectIdboolean

    Platform identifier for the project containing the patient and record.

  • select.visit.patientIdboolean

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

  • select.visit.subjectSiteKeyboolean

    Reference token for the facility or practitioner associated with the visit. Use the resolved site.id, not this token, to identify the site.

  • select.visit.attendingProviderIdboolean

    Platform practitioner reference for the attending provider associated with the visit.

  • select.visit.renderingProviderIdboolean

    Platform practitioner reference for the rendering provider associated with the visit.

  • select.visit.operatingProviderIdboolean

    Platform practitioner reference for the operating provider associated with the visit.

  • select.visit.payorIdboolean

    Reference identifier for the payer associated with the visit. The payor join supplies the payer name when available.

  • select.visit.procedureCountboolean

    Number of procedure records linked to the visit.

  • select.visit.diagnosisCountboolean

    Number of diagnosis records linked to the visit.

  • select.visit.prescriptionFillCountboolean

    Number of prescription dispensing records linked to the visit.

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

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

  • select.attendingProviderobject & object

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

  • select.renderingProviderobject & object

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

  • select.operatingProviderobject & object

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

  • select.payorobject & object

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

  • whereobject
  • where.visitobject

    Filters on the visit's columns.

  • where.visit.refobject | object | object | object | object | object | object | string[]

    Reference for the visit in the current data output. This reference can change when data is reprocessed and should not be used as a permanent identifier.

  • where.visit.encounterTypeobject | object | object | object | object | object | object | string[]

    Source-reported encounter category, such as inpatient or outpatient. Values depend on the contributing source and are not a fixed enumerated list.

  • where.visit.claimTypeobject | object | object | object | object | object | object | object | string[]

    Source-reported numeric claim-type code. Source-specific and may be blank.

  • where.visit.earliestServiceDateobject | object | object | object | object | object | object | object | string[]

    Earliest service date reported for the visit. This describes the care event, not the date of the search.

  • where.visit.latestServiceDateobject | object | object | object | object | object | object | object | string[]

    Latest service date reported for the visit. It may equal the earliest service date for a single-day encounter.

  • where.visit.memberIdobject | object | object | object | object | object | object | string[]

    Insurance member identifier reported in the source claims data. Preserve as text, including any leading zeros.

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

    Timestamp associated with the visit data in the platform. For merged visits, this is the newest contributing data timestamp and can change when newer data contributes.

  • where.visit.dataSourcesobject | object | object | object | object | object | object | string[]
  • where.visit.ehrDiscoveredobject | object | object | object | string[]

    Whether an electronic health record discovery source contributed to this visit. A true value indicates EHR discovery, subject to the account permissions needed to request records.

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

    Platform identifier for the customer organization associated with the record.

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

    Platform identifier for the project containing the patient and record.

  • where.visit.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.visit.subjectSiteKeyobject | object | object | object | object | object | object | string[]

    Reference token for the facility or practitioner associated with the visit. Use the resolved site.id, not this token, to identify the site.

  • where.visit.attendingProviderIdobject | object | object | object | object | object | object | string[]

    Platform practitioner reference for the attending provider associated with the visit.

  • where.visit.renderingProviderIdobject | object | object | object | object | object | object | string[]

    Platform practitioner reference for the rendering provider associated with the visit.

  • where.visit.operatingProviderIdobject | object | object | object | object | object | object | string[]

    Platform practitioner reference for the operating provider associated with the visit.

  • where.visit.payorIdobject | object | object | object | object | object | object | string[]

    Reference identifier for the payer associated with the visit. The payor join supplies the payer name when available.

  • where.visit.procedureCountobject | object | object | object | object | object | object | object | string[]

    Number of procedure records linked to the visit.

  • where.visit.diagnosisCountobject | object | object | object | object | object | object | object | string[]

    Number of diagnosis records linked to the visit.

  • where.visit.prescriptionFillCountobject | object | object | object | object | object | object | object | string[]

    Number of prescription dispensing records linked to the visit.

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

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

  • where.attendingProviderstring | object & object

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

  • where.renderingProviderstring | object & object

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

  • where.operatingProviderstring | object & object

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

  • where.payorstring | object & object

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

  • aggregateobject
  • aggregate.visitobject
  • aggregate.visit.countboolean

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

  • aggregate.visit.sumobject

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

  • aggregate.visit.avgobject

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

  • aggregate.visit.minobject

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

  • aggregate.visit.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.siteobject & object
  • aggregate.attendingProviderobject & object
  • aggregate.renderingProviderobject & object
  • aggregate.operatingProviderobject & object
  • aggregate.payorobject & object
  • orderByobject | object | object | object | object | object | object | object | object[]
  • searchstring
  • takeinteger
  • skipinteger

ReturnsTyped browse response for VisitBrowseResponse

Conditional attributes

  • tableobject[]
  • table[].visitobject & object

    The visit's columns, as selected by the request.

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

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

  • table[].attendingProviderobject & object

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

  • table[].renderingProviderobject & object

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

  • table[].operatingProviderobject & object

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

  • table[].payorobject & object

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

  • table[].actionsobject

    Computed for every row; it is not selected, filtered or sorted on.

  • table[].actions.createRecordRequeststring

    Relative application link that opens a new record request for the patient and facility. Blank when the visit has no facility subject.

  • table[].actions.createCcdaRequeststring

    Relative application link that opens a C-CDA request. Available when the visit has a facility reference, EHR discovery contributed, and the viewer can create C-CDA requests.

  • table[].actions.existingRequestCountsobject

    Existing record requests for this patient at this facility, counted by request type. All zero when the visit has no facility. Shared by every visit at the same facility, so do not sum across visits.

  • table[].actions.recordRequestCountinteger

    Total existing medical, imaging, and billing requests for this patient at this facility. Excludes C-CDA requests. Do not sum across visits at the same facility.

  • table[].actions.ccdaRequestCountinteger

    Number of existing C-CDA requests for this patient at this facility. Do not sum across visits at the same facility.

  • aggregateobject
  • aggregate.visitobject
  • aggregate.visit.countinteger

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

  • aggregate.visit.sumobject

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

  • aggregate.visit.avgobject

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

  • aggregate.visit.minobject

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

  • aggregate.visit.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.siteobject & object
  • aggregate.attendingProviderobject & object
  • aggregate.renderingProviderobject & object
  • aggregate.operatingProviderobject & object
  • aggregate.payorobject & object
  • totalinteger

Errors

400401500