Docs
Guides
IntroductionGraphQL Guide
API Reference
Queries24▾
AccountsQueriesAnalyticsQueriesBillingQueriesBoardQueriesBoardingQueriesClinicalQueriesConversationsQueriesEntitiesQueriesEventsQueriesHospitalQueriesInventoryQueriesLabQueriesMarketingQueriesNewBillingQueriesNotificationsQueriesPlanQueriesRdvmsQueriesRemindersQueriesScheduleQueriesTasksQueriesTelemedicineQueriesTreatmentQueriesTriggersQueriesVoiceCallQueries
Mutations26▾
AccountsMutationsAnalyticsMutationsBillingMutationsBoardMutationsBoardingMutationsClinicalMutationsCommentsMutationsConversationsMutationsEntitiesMutationsHospitalMutationsInventoryMutationsLabMutationsLicenseMutationsMarketingMutationsNewBillingMutationsNotificationsMutationsPayrollMutationsPlanMutationsRdvmsMutationsRemindersMutationsScheduleMutationsTasksMutationsTelemedicineMutationsTreatmentMutationsTriggersMutationsVoiceCallMutations
Type System
Objects400▾
AccountCreditHistoryResponseAccountsReceivableBalanceAddressAdministrationRouteAgedAccountsReceivableAgedAccountsReceivableTotalsAgedArReportGenerationAgedBucketAgedBucketConfigAlertAllergyAnalyticsDataAnalyticsDataRowAnalyticsDataRowBreakdownApiKeyAppointmentAppointmentIntakeDataAppointmentReasonCategoryAppointmentReminderAppointmentTypeAppointmentTypeTagApptCountProvidersArReconciliationAsyncMedicalRecordAttachmentAutoMessageAvailableTimeSlotBillingFrequencyOptionBillingGroupBillingGroupConnectionBillingGroupEdgeBillingGroupOptionBillingNoteBoardCellBoardGroupBoardingCageBoardingWardBoardRowBolusCalculationResultCadenceCageCallLogCardconnectCardInfoCardconnectMerchantSurchargeStatusCardconnectVerifyCredentialsResultCareTeamRoleChangelogChangelogConnectionChangelogEdgeCheckboxDatumChecklistDatumClientClientConnectionClientConsentClientEdgeClientExternalCommPreferencesValueClientRdvmClientReferralSourceClientResultClientTagClinicalNoteCommentComplicationConditionalConsentFormConversationConversationConnectionConversationEdgeConversationPageCoownerCoownerBreakdownCouponCouponProductCreditMemoCreditMemoTotalsCreditReasonCreditReasonRelatedCursorCustomAppointmentFieldCustomAppointmentFieldValueCustomClientFieldCustomClientFieldValueCustomLocationAttributeCustomPatientFieldCustomPatientFieldValueCustomPatientProtocolCustomVitalDashboardDatasyncLogDatasyncRecordsDateCountDeceasedPatientItemDeceasedPatientItemConnectionDeceasedPatientItemEdgeDeletionLogDepartmentDetailedCreditItemDetailedCreditItemConnectionDetailedCreditItemEdgeDetailedSalesRevenueItemDetailedSalesRevenueItemConnectionDetailedSalesRevenueItemEdgeDiagnosisDiagnosticDiagnosticConnectionDiagnosticEdgeDialpadOfficeDiscountReasonDosageCalculationResultDropdownDatumElectronicSignatureEmailStatusEmailTemplateEncounterSectionLockEncounterTypeSectionOverrideEntitiesTagEntityTagEntityTagGroupEntityValidationEstimateEstimateItemEstimatesTotalsEventEventConnectionEventEdgeExternalSearchResultExtraFieldFeatureFlagFieldDatumFieldDatumPartFileFileResultsFormDatumFormulaDatumFrequencyFulfillmentSourceHighlightHospitalizationHospitalizationTaskImageDatumImmunizationImmunizationConnectionImmunizationDatumImmunizationEdgeImportedEntityIntervalConfigInventoryAdjustmentInventoryLevelInventoryLogInvoiceLineItemReasonLabDeviceLabModifierLabOrderLabResultLabResultConnectionLabResultEdgeLabResultImageLabTestLateFeeLedgerEntryLedgerEntryTotalsLegalEntityLicenseLinkedClinicalNoteLocationLocationAttributeLocationChatMessageLocationChatNotificationLocationClientAccountCreditsLocationHoursLocationKpiLocationProviderScheduleLocationScheduleLocationTagLowStockThresholdMacroManualArAdjustmentResultMassUploadResultMasterProductMedicationMedicationConnectionMedicationEdgeMedicationIntegrationTransactionMedicationIntegrationTransactionConnectionMedicationIntegrationTransactionEdgeMedicationManufacturerMedicationsFilledReportItemMedicationsFilledReportResultMedicationsReportItemMedicationsReportResultMedicationStatusCountMessageModalityMonitorDatumMonographMonographGuideMonographSectionNewsletterNoteDatumNotificationNotificationMetadataNovaBoardCellNovaBoardRowCellsNovaBoardSheetNovaBoardUpdatePayloadObanJobOrderOrderFlagOrderItemOrderItemConnectionOrderItemEdgeOrderItemsTotalsOrderPaymentMismatchOrdersCountsOrdersTotalsOrderSuggestionOrgOrgDepartmentOrgLabOrgLabTypeMetadataOrgLabUpdateResultOrgPreferenceOutlookSyncResultPackPageInfoPatientPatientClinicalItemsPendingApprovalCountsPatientCompliancePatientComplicationPatientContactDetailsPatientDiagnosisPatientDocumentPatientDocumentConnectionPatientDocumentEdgePatientLocationPatientPlanPatientPlanChargePatientPlanItemPatientProtocolPatientProtocolConnectionPatientProtocolEdgePatientRdvmPatientTagPaymentPaymentReasonPaymentSourcePaymentsTotalsPendingImmunizationDatumPendingPackageDatumPendingRxDatumPermissionPharmacySnapshotPhoneNumberPlanOptionPlayPackDeferredRevenueItemPlayPackDeferredRevenueItemConnectionPlayPackDeferredRevenueItemEdgePlumbsHandoutPreventionPlanPriceChangePriceChangeFilterPriceTierPrintLabelResultPrintnodeComputersFieldPrintnodePrintersFieldProblemProcessorPaymentProductProductCategoryProductConfigProductDosageConfigProductManufacturerProductManufacturerPageProductMetadataFieldProductPackageProductPackageItemProductPriceProductSpeciesDosageConfigProductTypeProtocolProtocolReminderProtocolReminderByProtocolProviderProviderAppointmentTypeLimitProviderCommissionProviderConnectionProviderEdgeProviderPreferencesProviderPunchProviderRoleProviderTransferPurchaseOrderPurchaseOrderItemRdvmRdvmContactRdvmDocumentRdvmRecentPatientsRdvmVisitReconciliationNoteRecurrenceRelationshipReminderReminderSilenceRepeatingEventReportRowReservationReturnedOrderItemRevenueCenterRevenueCenterBudgetRootMutationTypeRootQueryTypeRootSubscriptionTypeRowUploadErrorRxDatumScheduleRecurrenceScheduleTemplateScheduleTemplateRangeSentAutoMessageSentReminderSketchDatumSpeciesStockLocationStockTransferStockTransferFulfillmentItemStockTransferItemStockTransferNoteStockTransferRequestStockTransferRequestConnectionStockTransferRequestEdgeStockTransferRequestItemStockTransferTemplateStockTransferTemplateConnectionStockTransferTemplateEdgeStockTransferTemplateItemStripeAddressStripeBillingDetailsStripeCardStripeClientSecretStripeCustomerStripeInvoiceSettingsStripePaymentIntentStripePaymentMethodStripePaymentTypeResultStripeReaderStripeUsBankAccountSyncClientResultTaskTaskCategoryTaskConnectionTaskEdgeTaskGroupTeletailsSessionTestResultTextDatumTimeSlotTreatmentTreatmentConnectionTreatmentDatumTreatmentEdgeTreatmentInfoTreatmentSheetTreatmentSheetCareTeamMemberTreatmentSheetCellTreatmentSheetCellCommentTreatmentSheetRowTreatmentSheetRowAdditiveTreatmentSheetRowAdditiveEntryTreatmentSheetRowBolusTreatmentSheetRowFluidTreatmentSheetTemplateTreatmentTimeIntervalTriggerTriggerAddOrderItemOptionsTriggerCreateTaskOptionsTriggerDefaultOptionsTriggerIgnoreProviderTriggerProductTriggerSendEmailOptionsTriggerWebhookOptionsUpdateAppointmentPositionsResultUsageReportUsageReportTotalsValuesetDatumValuesetDatumOptionVendorVetspireSubscriptionVetspireSubscriptionTierViewerVisitVisitHeaderConfigVisitHeaderDiagnosisSelectionVisitHeaderRdvmSelectionVisitsReportItemVisitsReportItemConnectionVisitsReportItemEdgeVitalDatumVitalsVitalsTemplateVoiceCallWeight
Unions5▾
BillChangelogEntityLocationOrLocationTagMessageSenderOrderable
Input Objects248▾
AccountCreditHistoryOrderByAccountsFiltersAccountsOrderByAddressInputAgedBucketConfigInputAgedBucketInputAlertInputAllergyInputAnalyticsFieldModifierAppointmentInputAppointmentIntakeDataInputAppointmentPositionInputAppointmentReminderInputAppointmentTypeInputAppointmentTypeTagInputApproveCubexDiagnosticInputApproveCubexEncounterProductInputApproveCubexImmunizationInputApproveCubexMedicationInputApproveCubexTreatmentInputApproveMedicationInputAssignOrphanImmunizationTransactionInputAssignOrphanImmunizationTransactionToNewEncounterInputAssignOrphanTransactionInputAutoMessageInputBillingGroupFiltersBillingGroupInputBillingGroupOrderByBillingNoteInputBoardCellInputBoardingBlockInputBoardingCageInputBoardingWardFiltersBoardingWardInputBoardRowInputCadenceInputCageInputCallLogInputChangelogFiltersChangelogOrderByClientExternalCommPreferencesInputClientFiltersClientInputClientRdvmInputClientReferralSourceInputClientTagInputClinicalNoteInputComplicationInputConditionalInputConsentFormInputConversationInputConversationSetAttachmentCoownerInputCouponInputCouponProductInputCreateCareTeamRoleInputCreateHarvestLabOrderInputCreateHarvestLabResultInputCreateIguanaLabOrderInputCreateIguanaLabResultInputCreateManualArAdjustmentInputCreateProviderTransferInputCreateStockTransferFulfillmentItemInputCreateStockTransferRequestInputCreateStockTransferRequestItemInputCreateStockTransferRequestItemsInputCreateStockTransferTemplateItemInputCreateTreatmentSheetInputCreditMemoInputCreditReasonInputCustomAppointmentFieldInputCustomAppointmentFieldValueInputCustomClientFieldInputCustomClientFieldValueInputCustomLocationAttributeInputCustomPatientFieldInputCustomPatientFieldValueInputCustomPatientProtocolInputCustomTreatmentSheetRowInputCustomVitalInputDepartmentInputDiagnosticInputDiscountReasonInputDosageConfigInputEmailTemplateInputEncounterSectionDatumReplaceInputEncounterTypeSectionOverrideItemInputEntitiesTagInputEntityTagGroupInputEntityTagInputEntityValidationInputEstimateInputEstimateItemInputEventMetadataFilterEventsOrderByExternalSearchInputExtraFieldInputFilterFulfillmentSourceInputHarvestExamInputHarvestExamResultInputHospitalizationInputHospitalizationTaskInputIguanaExamInputImmunizationFiltersImmunizationInputImportFromDocumentInputIntervalConfigInputInventoryAdjustmentInputInvoiceLineItemReasonInputLabModifierInputLabOrderInputLabResultInputLicenseInputLinkedClinicalNoteInputLocationAttributeInputLocationFiltersLocationHoursInputLocationInputLocationProviderScheduleInputLocationScheduleInputLocationTagInputLowStockThresholdInputMacroInputMedicationInputMedicationManufacturerInputMedicationPharmacyFieldsInputMedicationPharmacyStatusInputNewsletterInputNovaBoardFiltersOrderFlagInputOrderInputOrderItemInputOrderLineItemsFiltersOrderLineItemsOrderByOrgDepartmentInputOrgInputOrgLabInputOrgPreferenceInputPatientContactDetailsInputPatientDiagnosisInputPatientDocumentFiltersPatientDocumentInputPatientDocumentOrderByPatientFiltersPatientInputPatientLocationInputPatientPlanFiltersPatientPlanInputPatientPlanItemInputPatientProtocolFiltersPatientProtocolOrderByPatientRegistrationPatientTagInputPaymentInputPaymentReasonInputPaymentSourceInputPharmacyMedicationsOrderByPhoneNumberInputPlanOptionInputPreventionPlanInputPriceChangeFilterInputPriceChangeInputPriceTierInputPrinterInputProblemInputProductCategoryInputProductConfigInputProductInputProductManufacturerInputProductMetadataFieldInputProductPackageInputProductPackageItemInputProductPriceInputProductTypeFlagsProductTypeInputProtocolInputProtocolReminderInputProviderAppointmentTypeLimitInputProviderCommissionInputProviderInputProviderPreferencesInputProviderPunchInputProviderRoleInputProvidersFiltersProvidersOrderByProviderViewerInputPurchaseOrderInputPurchaseOrderItemInputRdvmContactInputRdvmInputRdvmVisitInputReconciliationNoteInputRecurrenceInputRelationshipInputReminderInputReminderSilenceInputRepeatingEventInputReservationFiltersReservationInputRevenueCenterBudgetInputRevenueCenterInputSaveTreatmentSheetCellOrderItemInputScheduleRecurrenceInputScheduleTemplateInputScheduleTemplateRangeInputSelectedItemsInputSpeciesDosageConfigInputStockLocationInputStockLocationUpdateStockTransferInputStockTransferItemInputStockTransferNoteInputStockTransferRequestFiltersStockTransferTemplateInputSyncClientInputTaskCategoryInputTaskGroupInputTaskInputTasksFiltersTasksOrderByTeletailsSessionInputTreatmentInputTreatmentSheetCareTeamMemberInputTreatmentSheetCellInputTreatmentSheetInputTreatmentSheetRowAdditiveEntryInputTreatmentSheetRowAdditiveInputTreatmentSheetRowBolusInputTreatmentSheetRowFluidInputTreatmentSheetRowInputTreatmentSheetTemplateInputTreatmentTemplateSectionTreatmentTimeIntervalInputTriggerInputUpdateCareTeamRoleInputUpdateHarvestLabOrderInputUpdateIguanaLabOrderInputUpdateProviderTransferInputUpdateStockTransferFulfillmentItemInputUpdateStockTransferRequestInputUpdateStockTransferRequestItemInputUpsertProductConfigInputVendorInputVisitItemInputVitalsInputVitalsTemplateInputVoiceCallInput
Enums112▾
ActionsEnumAddressUseAdminTagAgedArReportStatusAnalyticsBreakdownAnalyticsDataRowModifierAnalyticsFieldAnalyticsSegmentAppointmentStatusArBreakdownBillingGroupFeeTypeCadenceContactMethodsCallLogOutcomeCommentableEntityTypeComparisonConditionalOperatorContactTypeConversationMediumDayOfWeekDiagnosticStatusDiscountTypeDosageInputTypeDoseRangeStatusDoubleBookingConstraintEncounterPdfTypeEncounterProductStatusEncounterSummaryDocumentTypeEstimateStatusEstimateTypeEyeFeatureFlagEnumFeeCalculationMethodFilterFieldIguanaLabOrderEventTypeIguanaRisOrderUpdateStatusImmunizationStatusImmunizationTypeImportEntityTypeInferredResultTypesInvoiceSortFieldEnumInvoiceStatusIsoCountryLabelSizeLicenseTypeMedicationStatusMonthMonthlyDueDateTypeNotificationTypeNovaBoardCellStatusNovaBoardUpdateTypeObanJobStateOrderByDirectionOrderByEnumOrderSuggestionTypeOrgLabTypeOutlookSyncStatusPatientOrderByEnumPaymentMethodPaymentSortPharmacyRejectionReasonPharmacyStatusPlanIntervalPriceChangeFilterTypePriceChangeStatusPriceChangeTypePriceTypePricingTypeProblemTypeProductApplicationTypePronounsPurchaseOrderSortFieldPurchaseOrderStatusRecurrenceDeleteScopeRecurrenceEditScopeReminderEventReminderTypeRepeatTypeReportBreakdownReportSegmentReservationCategoryReservationStatusReservationStatusFilterReservationTimeReturnedOrderItemTypeRouteTypeScheduledDrugTypeSeveritySexSortDirectionSortFieldEnumSortOptionsSortProductOptionsStockTransferFulfillmentItemStatusStockTransferRequestStatusStockTransferStatusStripePaymentTypeSubscriptionModelTimeSegmentTreatmentSheetFormatTreatmentSheetRowFluidTypeTreatmentSheetSummaryTypeTreatmentSheetTypeTreatmentSheetUnitsTreatmentStatusTriggeredProtocolsSortFieldEnumTriggerIfTriggerThenVisitItemTypeVisitTypeWastageReasonWeekOfMonthWeightUnit
Scalars15▾
BooleanDateDateTimeDecimalFloatIDIntJSONNaiveDateTimeNumrangePriceStringTimeTruthyUpload
Object

Medication

A medication

Usage Example
query {
  # Use this type in your queries
  someQuery {
  creator
  cumulativeSiblingQuantity
  dateFilled
  daysSupply
  deaNumber
  }
}

Fields

creatorProvider

Provider who created the medication

cumulativeSiblingQuantityDecimal

Sum of quantities across all non-deleted medications in this refill chain, excluding this one

dateFilledDate

Date the medication was filled/dispensed

daysSupplyInt

Number of days the medication is expected to last

deaNumberString
declinedBoolean
dispenseCapDecimal

Max total quantity allowed across all fills (pharmacy_snapshot.quantity × (pharmacy_snapshot.refills + 1))

dispensedDecimal
doseString
encounterEncounter

(optional) Encounter the medication was prescribed during if applicable

frequencyString
fulfillmentSourceFulfillmentSource
historicalBoolean
idID!required
insertedAtNaiveDateTime
isExternalBoolean
isIssuedViaCubexBoolean
labelPdfString
+
labelPdfAutoString
+

Returns the appropriate label PDF based on the DIMSUMedicationsLabel feature flag

labelPdfModernString
locationLocation
locationIdID
lotNumberString

The prescription's lot number

medicationManufacturers[MedicationManufacturer]
nameString

Detailed name of the medication prescribed

noteString

Additional information about the prescription

orderItemOrderItem
orderSuggestionOrderSuggestion
patientPatient

Patient whom is taking the medication

pdfString
+
pharmacyApprovedAtDateTime

Timestamp when the prescription was approved

pharmacyApprovedByProvider

Provider who approved the prescription in the pharmacy

pharmacyCollectedByProvider

Provider who collected/picked up the prescription

pharmacyFillInProgressAtDateTime

Timestamp when the prescription entered the Fill In Progress pharmacy status

pharmacyFillInProgressByProvider

Provider who moved the prescription into the Fill In Progress pharmacy status

pharmacyFillVerificationAtDateTime

Timestamp when the prescription entered the Final Rx Check pharmacy status

pharmacyFillVerificationByProvider

Provider who moved the prescription into the Final Rx Check pharmacy status

pharmacyFilledByProvider

Provider who filled the prescription in the pharmacy

pharmacyOnHoldByProvider

Provider who placed the prescription on hold

pharmacyPrescriptionApprovedAtDateTime

Timestamp when the prescription entered the Rx Approved pharmacy status

pharmacyPrescriptionApprovedByProvider

Provider who moved the prescription into the Rx Approved pharmacy status

pharmacyRejectedByProvider

Provider who rejected the prescription

pharmacyRejectionReasonPharmacyRejectionReason

Reason for rejecting the prescription

pharmacySnapshotPharmacySnapshot

Immutable snapshot of the medication's original state when first sent to pharmacy

pharmacyStatusPharmacyStatus
pharmacyVerifiedAtDateTime

Timestamp when the prescription was verified

pharmacyVerifiedByProvider

Provider who verified the prescription

prescriberProvider

Provider who prescribed the medication

productProduct
productIdID
quantityDecimal

The amount of the medication

quantityUnitString
refillByDateDate

Date the medication's refills are valid by

refillParentMedication
refillSequenceInt

Position in the refill chain (0 = original, 1 = first refill, etc.)

refillsInt

Number of refills originally prescribed

refillsUsedInt

number of refills used

requestedByProvider

Provider who originally requested this medication or requested approval for this medication order

rootMedicationMedication
rootMedicationIdID

ID of the original medication in a refill chain

sigString

Label/instructions for the administration of the medication

sourceDocumentPatientDocument
startDate

Date the medication's administration started

stopDate

Date the medication's administration should cease

toGoHomeBoolean

Indicates whether this medication is intended for the client to take home

updatedAtNaiveDateTime
usesLegacyRefillsBoolean

Whether this medication uses legacy per-fill RX numbering

vetsourcedBoolean
vialNumberString

The prescription's vial number

visitVisit
wasteQuantityDecimal

The amount wasted from Cubex