Skip to content
Hermes Health API
GuidesOpenAPI spec

Endpoints

Prescription fills

POST/v0/prescription-fills/browse

Browse prescription fills

Queries the prescription fills 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.prescriptionFillobject

    Which of the prescription fill's columns to return.

  • select.prescriptionFill.refboolean

    Reference for this prescription dispensing record in the current output. It can change when clinical data is reprocessed.

  • select.prescriptionFill.ndcboolean

    National Drug Code identifying the dispensed product. Stored as an 11-digit normalized code without dashes. Preserve as text.

  • select.prescriptionFill.rxCuiboolean

    RxNorm concept identifier associated with the drug, when the product can be resolved in the reference data.

  • select.prescriptionFill.drugLabelboolean

    Drug label supplied with the prescription data.

  • select.prescriptionFill.prescriptionNumberboolean

    Prescription number assigned by the source pharmacy or prescription system. Preserve as text.

  • select.prescriptionFill.fillNumberboolean

    Fill sequence for the prescription. Zero means the original fill; one or greater means a refill.

  • select.prescriptionFill.daysSupplyboolean

    Number of days the dispensed quantity is expected to cover, as reported by the source.

  • select.prescriptionFill.quantityDispensedboolean

    Quantity dispensed for this fill. The unit depends on the drug or product; there is no separate quantity-unit field.

  • select.prescriptionFill.strengthboolean

    Drug strength or dosage text supplied with the prescription record.

  • select.prescriptionFill.totalRefillsAllowedboolean

    Total number of refills authorized for the prescription, as reported by the source.

  • select.prescriptionFill.fcraDisputeboolean

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

  • select.prescriptionFill.fillDateboolean

    Date the prescription was filled or refilled.

  • select.prescriptionFill.createdAtboolean

    Timestamp when the prescription-fill data was recorded in the platform. This is separate from the fill date.

  • select.prescriptionFill.companyIdboolean

    Platform identifier for the customer organization associated with the record.

  • select.prescriptionFill.projectIdboolean

    Platform identifier for the project containing the patient and record.

  • select.prescriptionFill.patientIdboolean

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

  • select.prescriptionFill.visitRefboolean

    Reference to the visit associated with this dispensing event. The reference may change when the data is reprocessed.

  • select.prescriptionFill.siteIdboolean

    Platform reference for the dispensing pharmacy associated with the prescription fill.

  • select.prescriptionFill.prescriberPractitionerIdboolean

    Platform practitioner reference for the prescribing provider, when that provider is resolved.

  • select.drugobject & object

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

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

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

  • select.siteobject & object

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

  • select.prescriberobject & object

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

  • whereobject
  • where.prescriptionFillobject

    Filters on the prescription fill's columns.

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

    Reference for this prescription dispensing record in the current output. It can change when clinical data is reprocessed.

  • where.prescriptionFill.ndcobject | object | object | object | object | object | object | string[]

    National Drug Code identifying the dispensed product. Stored as an 11-digit normalized code without dashes. Preserve as text.

  • where.prescriptionFill.rxCuiobject | object | object | object | object | object | object | string[]

    RxNorm concept identifier associated with the drug, when the product can be resolved in the reference data.

  • where.prescriptionFill.drugLabelobject | object | object | object | object | object | object | string[]

    Drug label supplied with the prescription data.

  • where.prescriptionFill.prescriptionNumberobject | object | object | object | object | object | object | string[]

    Prescription number assigned by the source pharmacy or prescription system. Preserve as text.

  • where.prescriptionFill.fillNumberobject | object | object | object | object | object | object | object | string[]

    Fill sequence for the prescription. Zero means the original fill; one or greater means a refill.

  • where.prescriptionFill.daysSupplyobject | object | object | object | object | object | object | object | string[]

    Number of days the dispensed quantity is expected to cover, as reported by the source.

  • where.prescriptionFill.quantityDispensedobject | object | object | object | object | object | object | object | string[]

    Quantity dispensed for this fill. The unit depends on the drug or product; there is no separate quantity-unit field.

  • where.prescriptionFill.strengthobject | object | object | object | object | object | object | string[]

    Drug strength or dosage text supplied with the prescription record.

  • where.prescriptionFill.totalRefillsAllowedobject | object | object | object | object | object | object | object | string[]

    Total number of refills authorized for the prescription, as reported by the source.

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

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

  • where.prescriptionFill.fillDateobject | object | object | object | object | object | object | object | string[]

    Date the prescription was filled or refilled.

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

    Timestamp when the prescription-fill data was recorded in the platform. This is separate from the fill date.

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

    Platform identifier for the customer organization associated with the record.

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

    Platform identifier for the project containing the patient and record.

  • where.prescriptionFill.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.prescriptionFill.visitRefobject | object | object | object | object | object | object | string[]

    Reference to the visit associated with this dispensing event. The reference may change when the data is reprocessed.

  • where.prescriptionFill.siteIdobject | object | object | object | object | object | object | string[]

    Platform reference for the dispensing pharmacy associated with the prescription fill.

  • where.prescriptionFill.prescriberPractitionerIdobject | object | object | object | object | object | object | string[]

    Platform practitioner reference for the prescribing provider, when that provider is resolved.

  • where.drugstring | object & object

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

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

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

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

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

  • aggregateobject
  • aggregate.prescriptionFillobject
  • aggregate.prescriptionFill.countboolean

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

  • aggregate.prescriptionFill.sumobject

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

  • aggregate.prescriptionFill.avgobject

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

  • aggregate.prescriptionFill.minobject

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

  • aggregate.prescriptionFill.maxobject

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

  • aggregate.drugobject & object
  • aggregate.companyobject & object
  • aggregate.projectobject & object
  • aggregate.patientobject & object
  • aggregate.visitobject & object
  • aggregate.siteobject & object
  • aggregate.prescriberobject & object
  • orderByobject | object | object | object | object | object | object | object[]
  • searchstring
  • takeinteger
  • skipinteger

ReturnsTyped browse response for PrescriptionFillBrowseResponse

Conditional attributes

  • tableobject[]
  • table[].prescriptionFillobject

    The prescription fill's columns, as selected by the request.

  • table[].prescriptionFill.refstring

    Reference for this prescription dispensing record in the current output. It can change when clinical data is reprocessed.

  • table[].prescriptionFill.idstringDeprecated

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

  • table[].prescriptionFill.ndcstring

    National Drug Code identifying the dispensed product. Stored as an 11-digit normalized code without dashes. Preserve as text.

  • table[].prescriptionFill.rxCuistring

    RxNorm concept identifier associated with the drug, when the product can be resolved in the reference data.

  • table[].prescriptionFill.drugLabelstring

    Drug label supplied with the prescription data.

  • table[].prescriptionFill.prescriptionNumberstring

    Prescription number assigned by the source pharmacy or prescription system. Preserve as text.

  • table[].prescriptionFill.fillNumberinteger

    Fill sequence for the prescription. Zero means the original fill; one or greater means a refill.

  • table[].prescriptionFill.daysSupplyinteger

    Number of days the dispensed quantity is expected to cover, as reported by the source.

  • table[].prescriptionFill.quantityDispensedstring

    Quantity dispensed for this fill. The unit depends on the drug or product; there is no separate quantity-unit field.

  • table[].prescriptionFill.strengthstring

    Drug strength or dosage text supplied with the prescription record.

  • table[].prescriptionFill.totalRefillsAllowedinteger

    Total number of refills authorized for the prescription, as reported by the source.

  • table[].prescriptionFill.fcraDisputeboolean

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

  • table[].prescriptionFill.fillDatestring

    Date the prescription was filled or refilled.

  • table[].prescriptionFill.createdAtstring

    Timestamp when the prescription-fill data was recorded in the platform. This is separate from the fill date.

  • table[].prescriptionFill.companyIdinteger

    Platform identifier for the customer organization associated with the record.

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

  • table[].prescriptionFill.projectIdstring

    Platform identifier for the project containing the patient and record.

  • table[].prescriptionFill.patientIdstring

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

  • table[].prescriptionFill.visitRefstring

    Reference to the visit associated with this dispensing event. The reference may change when the data is reprocessed.

  • table[].prescriptionFill.visitIdstringDeprecated

    Legacy alias of `visitRef`; prefer `visitRef`.

  • table[].prescriptionFill.siteIdstring

    Platform reference for the dispensing pharmacy associated with the prescription fill.

  • table[].prescriptionFill.prescriberPractitionerIdstring

    Platform practitioner reference for the prescribing provider, when that provider is resolved.

  • table[].drugobject & object

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

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

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

  • table[].siteobject & object

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

  • table[].prescriberobject & object

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

  • aggregateobject
  • aggregate.prescriptionFillobject
  • aggregate.prescriptionFill.countinteger

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

  • aggregate.prescriptionFill.sumobject

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

  • aggregate.prescriptionFill.avgobject

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

  • aggregate.prescriptionFill.minobject

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

  • aggregate.prescriptionFill.maxobject

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

  • aggregate.drugobject & object
  • aggregate.companyobject & object
  • aggregate.projectobject & object
  • aggregate.patientobject & object
  • aggregate.visitobject & object
  • aggregate.siteobject & object
  • aggregate.prescriberobject & object
  • totalinteger

Errors

400401500