query { # Use this type in your queries someQuery { acquireEncounterSectionLock acquireFaxNumber acquirePharmacyMedicationLock acquireTollFreeNumber acquireTwilioPhoneNumber }}acquireEncounterSectionLockEncounterSectionLockacquireFaxNumberLocationacquirePharmacyMedicationLockPharmacyMedicationLockacquireTollFreeNumberLocationacquireTwilioPhoneNumberLocationaddClientStripeInfoClientaddCreditMemoCreditMemoaddCustomTreatmentSheetRowTreatmentSheetRowaddEstimateItem[EstimateItem]addItemsToVisitVisitaddLinkedClinicalNoteLinkedClinicalNoteaddLinkedEncounterLinkedEncounteraddLinkedProductProductaddOrderItem[OrderItem]addOrderItemToEncounterOrderItemaddPackageToEncounterEncounteraddPackageToEstimateEstimateaddPackageToOrderOrderaddPackageToPackageProductPackageaddPatientPlanItemPatientPlanItemaddPatientRdvmPatientaddPatientToBoardBoardRowaddPurchaseOrderItemPurchaseOrderItemaddStockTransferItemStockTransferItemaddTestsToLabOrderLabOrderaddTreatmentTreatmentaddTreatmentSheetCellCommentTreatmentSheetCelladdTreatmentSheetRowTreatmentSheetRowapplyAccountCreditOrderapplyCouponOrderapplyEstimateCouponEstimateapplyStockTransferTemplateStockTransferRequestApprove a cubex-related diagnostic with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Approve a cubex-related encounter product with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Approve a cubex-related immunization with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Approve a cubex-related medication with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Approve a cubex-related treatment with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Links an orphan immunization transaction to a patient and an existing encounter. Should only be used when the Cubex Two-Way integration is enabled
Links an orphan immunization transaction to a patient and a new encounter. Should only be used when the Cubex Two-Way integration is enabled
Links an orphan transaction to a patient and an existing encounter. Should only be used when the Cubex Two-Way integration is enabled
Links an orphan transaction to a patient and a new encounter. Should only be used when the Cubex Two-Way integration is enabled
autoApplyCouponsOrderautoApplyEstimateCouponsEstimateautoApplyProductCouponsOrderbatchReplaceEncounterSectionDatumsEncounterAtomically replaces multiple encounter section datums in a single transaction. All replacements are validated and executed atomically - if any datum doesn't exist, the entire operation rolls back.
batchUpsertOrgPreferences[OrgPreference]Batch create or update multiple org preferences in a single operation
billingHistoryStringbillingStatementStringbulkMarkRemindersAsSentBooleanbulkUpdateEncounterTypeSectionOverridesEncounterTypecancelDatasyncDatasyncLogcancelLabOrderLabOrdercancelPlanPatientPlancaptureClientConsentStringchargeClientPaymentchargeEstimateEstimatechargeOrderOrderclientConsentLinkStringclockInProviderPunchclockOutProviderPunchcommentCommentcompleteBoardCellBoardRowconvertCallLogToAppointmentAppointmentconvertEstimateToOrderEstimatecopyFromPreviousEncounterEncountercopyMedicationsToEncounterEncountercopyPackageProductPackagecreateAlertAlertcreateAllergyAllergycreateApiKeyApiKeycreateAppointmentReasonCategoryAppointmentReasonCategorycreateApptVitalsAppointmentcreateBillingGroupBillingGroupcreateBridgeUserProvidercreateCadenceCadencecreateCareTeamRoleCareTeamRolecreateClientTagClientTagcreateConversationConversationcreateCreditReasonCreditReasoncreateCustomAppointmentFieldValueCustomAppointmentFieldValueCreates a custom appointment field value
createCustomLocationAttributeCustomLocationAttributecreateCustomPatientProtocolCustomPatientProtocolcreateDeclineReasonDeclineReasoncreateDiscountReasonDiscountReasoncreateEncounterOrderEncountercreateEncounterSectionEncounterInserts a new section for the given `encounter_id`'s sections at the `section_idx`th position
createEncounterSectionDatumEncounterInserts the given datum for the given encounter's `section_idx` at the `datum_idx`th position
createEncounterTypeEncounterTypecreateEstimateEstimatecreateHarvestLabOrderLabOrdercreateHarvestLabResultLabResultcreateHospitalizationTaskHospitalizationTaskcreateIguanaLabOrderLabOrdercreateIguanaLabResultLabResultcreateInventoryAdjustmentInventoryAdjustmentcreateInvoiceLineItemReasonInvoiceLineItemReasoncreateLabModifierLabModifiercreateLicenseLicensecreateLocationLocationCreate manual AR adjustment for prior periods
createNewsletterNewslettercreateOrderOrdercreateOrgLabWithCheckOrgLabUpdateResultCreates a lab integration for a location. If the integration supports it, checks the given credentials and reports whether they authenticated successfully.
createOutlookOrgPreferenceOrgPreferencecreateParentProblemProblemcreatePaymentReasonPaymentReasoncreateProductProductcreateProductManufacturerProductManufacturercreateProductPackageProductPackagecreateProductPriceProductPricecreateProviderProvidercreateProviderPinProvidercreateProviderTransferProviderTransfercreatePurchaseOrderPurchaseOrdercreateRdvmRdvmcreateScheduleRecurrenceScheduleRecurrencecreateStockLocationStockLocationcreateStockTransferStockTransfercreateStockTransferFulfillmentItemStockTransferFulfillmentItemcreateStockTransferReportRecipientStockTransferReportRecipientcreateStockTransferRequestStockTransferRequestcreateStockTransferRequestItemStockTransferRequestItemcreateStockTransferRequestItems[StockTransferRequestItem]createStockTransferTemplateStockTransferTemplatecreateStockTransferTemplateItemStockTransferTemplateItemcreateStripePaymentIntentStringcreateTaskTaskcreateTaskCategoryTaskCategorycreateTeletailsSessionTeletailsSessioncreateTreatmentSheetTreatmentSheetcreateTreatmentSheetCellTreatmentSheetCellcreateTreatmentSheetTemplateTreatmentSheetTemplatecreateTriggerTriggercreateUserTaskTaskcreateVitalsVitalscreateVoiceCallLogVoiceCallcreditMemoPdfStringDecline a cubex-related diagnostic with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Decline a cubex-related encounter product with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Decline a cubex-related immunization with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Decline a cubex-related medication with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
Decline a cubex-related treatment with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
declinePackageEstimateItemdeleteAppliedCouponOrderdeleteAppliedEstimateCouponEstimatedeleteAppointmentAppointmentdeleteAppointmentReasonCategoryAppointmentReasonCategorydeleteBillingGroupBillingGroupdeleteCadenceCadencedeleteCageCagedeleteClientConsentClientConsentdeleteClientTagClientTagdeleteCustomAppointmentFieldValueCustomAppointmentFieldValueDeletes a custom appointment field value
deleteCustomLocationAttributeCustomLocationAttributedeleteCustomLocationProviderScheduleLocationProviderScheduledeleteEncounterEncounterdeleteEncounterSectionEncounterDeletes the corresponding section for the given `encounter_id`'s sections at the `section_idx`th position
deleteEncounterSectionDatumEncounterDeletes the `datum_idx`th datum for the given encounter's `section_idx`
deleteEncounterTypeSectionOverridesEncounterTypedeleteEntitiesTagEntitiesTagdeleteEstimateEstimatedeleteEstimateItemEstimateItemdeleteFieldServiceAddressFieldServiceAddressDeletes one of a patient's field service visit addresses, returning the deleted address. Appointments already booked against the address keep their booking and lose their visit location, so deleting an address referenced by future appointments is safe.
deleteImportedDataDeletionLogdeleteLabModifierLabModifierdeleteLabOrderLabOrderdeleteLicenseLicensedeleteLinkedClinicalNoteClinicalNotedeleteLinkedEncounterEncounterdeleteLinkedProductProductdeleteLocationLocationdeleteMedicationMedicationdeleteMessageMessagedeleteOrderOrderdeleteOrderItemOrderItemdeleteOrgLabOrgLabDeletes an orphan transaction. Should only be used when the Cubex Two-Way integration is enabled
deletePackagePackageProductPackagedeletePatientDocumentPatientDocumentdeleteProductProductdeleteProductManufacturerProductManufacturerdeleteProductPackageProductPackagedeletePurchaseOrderPurchaseOrderdeletePurchaseOrderItemPurchaseOrderItemdeleteRdvmRdvmdeleteRdvmDocumentRdvmDocumentdeleteStockTransferStockTransferdeleteStockTransferFulfillmentItemStockTransferFulfillmentItemdeleteStockTransferItemStockTransferItemdeleteStockTransferReportRecipientStockTransferReportRecipientdeleteStockTransferRequestStockTransferRequestdeleteStockTransferRequestItemStockTransferRequestItemdeleteStockTransferTemplateStockTransferTemplatedeleteStockTransferTemplateItemStockTransferTemplateItemdeleteTaskCategoryTaskCategorydeleteTreatmentSheetTreatmentSheetdeleteTreatmentSheetRowTreatmentSheetRowdeleteTreatmentSheetRowAdditiveEntryTreatmentSheetRowAdditiveEntrydeleteTreatmentSheetTemplateTreatmentSheetTemplatedeleteTriggerTriggerdisableCreditReasonCreditReasondisableDeclineReasonDeclineReasondisableDiscountReasonDiscountReasondisableInvoiceLineItemReasonInvoiceLineItemReasondisablePaymentReasonPaymentReasondownloadBillingGroupStatementsStringDownloads billing statements for all clients in the specified billing group as a combined PDF. Returns a base64-encoded PDF file.
downloadProtocolsMigrationCsvStringdownloadUsageReportStringeditPatientRdvmPatientemailBillingGroupStatementsBooleanEmails billing statements to all clients in the specified billing groups. Each client with a billing email on file will receive their own billing statement. When `emailAll` is true, emails all billing groups in the org.
emailBillingStatementsBooleanEither zips & emails all billing statements at the given location to the list of provided emails, or if no emails are provided, emails each client their billing statement if they have one.
emailClientPaymentReceiptStringemailClientsAddressesStringemailCreditMemoToClient[EmailStatus]emailEncounter[EmailStatus]emailEncounterRecord[EmailStatus]emailEncounterRecordToCustom[EmailStatus]emailEncounterRecordToRdvms[EmailStatus]emailEstimateToClient[EmailStatus]emailFilteredProductsStringemailHospitalizationNoticeToRdvms[EmailStatus]emailImmunizationsRecordStringemailInventoryCsvStringemailInvoiceToClient[EmailStatus]emailLabResult[EmailStatus]emailMedicalRecordsSummaryStringemailPatientCompliancesReportStringemailProductsCsvStringemailRabiesCertificateStringemailRdvmsCsvStringemailRemindersCsvStringemailSelectedRabiesCertificatesStringemailTreatmentSheetSummaryStringemailUsageReportBooleanendOfDayReportStringendVideoCallStringendVisitVisitenrollPlanPatientPlanfetchVetrocketImagesLabResultfinishLabOrderLabOrdergenVetsourceUrlStringgenerateClientAuthTokenStringgenerateInventoryReportStringgenerateInvoiceOrdergenerateLabTrends[String]Start generating trends for the analytes named. One job covers the set, and the engine writes a single narrative over it, so ask for analytes that belong together -- the summary drawer asks for the results it flagged abnormal. The set is also the run's identity: the same analytes asked for again inside fifteen minutes are the run already in flight, and a different set replaces it. Answers with the analytes it started, and with nothing when the run was already there. Where it gets to is `labTrends` to say, since the engine's webhook is what finishes a job.
generatePlumbsPdfUrlStringgeneratePlumbsUrlStringgenerateUsageSummaryReportStringgenerateVetcalculatorIframeUrlStringGenerates an authenticated VetCalculator iframe URL for the current user
groupOrderItemsByPatientOrderimportFromDocumentImportedEntityImport an entity from a patient document. Exactly one of medication, immunization, or patient_protocol must be provided.
initiateCareCreditPrefillCareCreditPrefillSessioninitiateCareCreditPrefillRefundCareCreditPrefillSessioninsertNewTemplateEncounterinvoiceBarcodesPdfStringinvoiceBoardRowOrderissueCreditDiscountStringlinkAppointments[Appointment]linkCallVoiceCalllinkPatientPlanChargeToOrderItemPatientPlanChargemakeAppointmentTypeDefaultAppointmentTypemarkAllNormalEncounterEncounterMark a cubex-related diagnostic as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
Mark a cubex-related encounter product as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
Mark a cubex-related immunization as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
Mark a cubex-related medication as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
Mark a cubex-related treatment as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
markOrderPaidIfFullyPaidOrdermarkOrderUncollectibleOrdermarkPaymentAsRefundedPaymentmarkPostcardProtocolReminderAsSentProtocolRemindermarkVisitReadyForDischargeVisitmassMicrochipRegister[String]mergeClientReferralSources[ClientReferralSource]mergeClientsClientmergePatientsPatientmovePatientToClientPatientnewVendorVendoronboardPetdxLabOrgLaborderLabLabOrderpaymentReceiptPdfStringperformDatasyncDatasyncLogprintLabelPrintnodePrintLabelResultpromoteEstimateToBoardBoardRowpushDiagnosticToCubexStringPushes a diagnostic to Cubex. Can be used when the Cubex Sync feature is enabled
pushEncounterProductToCubexStringPushes an encounter product to Cubex. Can be used when the Cubex Sync feature is enabled
pushImmunizationToCubexStringpushMedicationToCubexStringpushToCubexStringpushTreatmentToCubexStringreadAllNotificationsIntreadNotificationNotificationreassignProductTypeProductTyperecordPatientWeightVitalsrecordStripeSdkRefundPaymentrefillAndSendToPharmacyMedicationrefillMedicationMedicationrefreshLabResultLabResultrefreshPreventionPlan[PatientPlan]refundOrderItemOrderItemrefundPaymentPaymentregisterPatientMicrochipPatientremoveClientStripeInfoStringremoveItemsFromVisitVisitremovePatientPlanItemPatientPlanItemremovePatientRdvmPatientreopenEncounterEncounterreopenOrderOrderreopenVisitVisitreorderAlerts[Alert]reorderClientReferralSources[ClientReferralSource]reorderEntityTags[EntityTag]reorderEstimateItemsEstimatereorderOrderItemsOrderreplaceEncounterSectionDatumEncounterReplaces a given datum by (section_idx x datum_idx) with provided JSON. Note that no validity checking of the datum input is performed. If you wish to simply update a given datum, you can more safetly use `replace_encounter_section_datum` instead.
requestMedicationApprovalMedicationUpdate a draft medication to request approval from a veterinarian
requestSourceDataDownloadUrlDatasyncLogresendVerificationStringresetProviderPinProviderretryJobObanJobretryLabOrderPlacementLabOrderreturnOrderItem[ReturnedOrderItem]saveEstimateEstimatesaveMicrochipPatientCreate or update the current org's AI PDF extraction rule. Only the given fields change, so saving a test run leaves the rule's active flag alone.
saveProviderElectronicSignatureElectronicSignaturesaveTreatmentSheetCellOrderItemTreatmentSheetCellsaveTreatmentSheetRowAdditiveEntryTreatmentSheetRowAdditiveEntrysendApptConfirmationAppointmentsendCardConnectHostedPaymentRequestStringsendCareCreditPaymentUrlStringsendClientCheckinLinkStringsendEmailVerificationClientsendEstimateConsentDepositLinkStringsendInvoiceToHfdHfdApplicationResultsendLocationChatMessageLocationChatMessagesendMessageMessagesendNewsletterNewslettersendNewsletterTestStringsendOutlookEmailVerificationProvidersendPaymentRequestStringsendReminderProtocolRemindersendSurveyLinkStringsendTestEmailStringsetApptPickupTimeAppointmentsetChatLastReadAtStringsetDaycareOpenBooleansetFeatureFlagBooleansetProviderFeatureFlagProviderFeatureFlagsignTreatmentSheetTreatmentSheetstartAsyncMedicalRecordAsyncMedicalRecordstartConversationConversationStart a test extraction using the given per-type instructions. Upload a PDF, or omit it to re-run against the one already stored on the org's rule.
startVisitVisitstripeAttachPaymentMethodToCustomerStripePaymentMethodstripeCancelReaderActionStripeReaderstripeUpsertCustomerStripeCustomersurgeryLogPdfStringswitchStockTransferStockTransfersyncClientSyncClientResulttestMicrosoftCalendarIntegrationStringtestScribeInstructionsScribeTestResulttextApptReadyAppointmenttoggleEncounterSectionCompletedByEncounterSectionToggle the completed by status of an encounter section
transferPatientPatienttriggerPrescriptionMedicationuncompleteBoardCellBoardCellundoManualAdjustmentInventoryAdjustmentundoWastageAdjustmentInventoryAdjustmentunlinkAppointmentAppointmentunlinkCallVoiceCallupdateAlertAlertupdateAllergyAllergyupdateAppointmentAppointmentupdateAppointmentIntakeAppointmentIntakeDataupdateAppointmentPositionsUpdateAppointmentPositionsResultUpdate appointment positions in the queue. Used for drag-and-drop reordering.
updateAppointmentReasonCategoryAppointmentReasonCategoryupdateBillingGroupBillingGroupupdateBoardCellBoardCellupdateBoardRowBoardRowupdateCadenceCadenceupdateCageCageupdateCallLogCallLogupdateCareCreditMerchantIdLocationupdateCareTeamRoleCareTeamRoleupdateClientExternalCommPreferencesClientExternalCommPreferencesValueupdateClientRdvmClientRdvmupdateClientReferralSourceClientReferralSourceupdateClientTagClientTagupdateClinicalNoteClinicalNoteupdateCommentCommentupdateConsentFormConsentFormupdateConversationConversationupdateCreditReasonCreditReasonupdateCustomAppointmentFieldCustomAppointmentFieldUpdates a custom appointment field (only includeOnAppointment can be modified)
updateCustomAppointmentFieldValueCustomAppointmentFieldValueUpdates a custom appointment field value
updateCustomLocationAttributeCustomLocationAttributeupdateCustomPatientFieldCustomPatientFieldUpdates a custom patient field (only includeOnAppointment can be modified)
updateCustomPatientProtocolCustomPatientProtocolupdateCustomTreatmentSheetRowTreatmentSheetRowupdateDeclineReasonDeclineReasonupdateDiagnosticDiagnosticupdateDiscountReasonDiscountReasonupdateEncounterProductEncounterProductupdateEncounterSectionEncounterUpdates the section corresponding to the given `section_idx` for the given `encounter_id`
updateEncounterSectionDatumEncounterUpdates a given datum by (section_idx x datum_idx) with provided changeset
updateEncounterTypeEncounterTypeupdateEntityTagEntityTagupdateEntityTagGroupEntityTagGroupupdateEstimateEstimateupdateEstimateItemEstimateItemupdateEstimateItemsEstimateupdateFieldServiceAddressFieldServiceAddressUpdates one of a patient's field service visit addresses
updateFulfillmentSourceFulfillmentSourceupdateHarvestLabOrderLabOrderupdateHospitalizationHospitalizationupdateHospitalizationTaskHospitalizationTaskupdateIguanaLabOrderLabOrderupdateImmunizationImmunizationupdateInvoiceLineItemReasonInvoiceLineItemReasonupdateLabModifierLabModifierupdateLabOrderLabOrderupdateLabResultLabResultupdateLicenseLicenseupdateLocationLocationUpdates a location. Use updateLocationIntegrations for Cubex and other integration updates requiring credential validation.
updateLocationAttributeLocationAttributeupdateLocationHoursLocationHoursupdateLocationIntegrationsLocationIntegrationsUpdates a location's integrations settings and validates Cubex credentials when provided
updateLocationProviderScheduleLocationProviderScheduleUpdate a medication with pharmacy status support
updateNewsletterNewsletterupdateOrderOrderupdateOrderFlagOrderFlagupdateOrderItemOrderItemupdateOrderItemsOrderUpdates a lab integration for a location. If the integration supports it, checks the given credentials and reports whether they authenticated successfully.
updateOrgPreferenceOrgPreferenceupdateOutlookOrgPreferenceOrgPreferenceupdatePatientPatientupdatePatientComplicationPatientComplicationupdatePatientDocumentPatientDocumentupdatePatientPlanItemPatientPlanItemupdatePaymentPaymentupdatePaymentReasonPaymentReasonupdatePreventionPlanPreventionPlanupdateProblemProblemupdateProductCubexEnabledProductControls whether a product is synced to Cubex at the specified location. Requires the Cubex Sync feature to be enabled.
updateProductEnabledProductupdateProductManufacturerProductManufacturerupdateProductPackageProductPackageupdateProductPackageItemProductPackageItemupdateProductPriceProductPriceupdateProductProductCategoryProductupdateProtocolProtocolupdateProtocolReminderProtocolReminderupdateProviderProviderupdateProviderTransferProviderTransferupdatePurchaseOrderPurchaseOrderupdatePurchaseOrderItemPurchaseOrderItemupdateQuantityStockTransferItemStockTransferItemupdateRdvmRdvmupdateRdvmContactRdvmContactupdateRdvmVisitRdvmVisitupdateReminderReminderupdateReminderSilenceReminderSilenceupdateRevenueCenterRevenueCenterupdateScheduleTemplateScheduleTemplateupdateStockLocationStockLocationupdateStockTransferStockTransferupdateStockTransferFulfillmentItemStockTransferFulfillmentItemupdateStockTransferItemStockTransferItemupdateStockTransferNotesStockTransferNoteupdateStockTransferReportRecipientStockTransferReportRecipientupdateStockTransferRequestStockTransferRequestupdateStockTransferRequestItemStockTransferRequestItemupdateStockTransferTemplateStockTransferTemplateupdateStockTransferTemplateItemStockTransferTemplateItemupdateTaskTaskupdateTaskCategoryTaskCategoryupdateTreatmentTreatmentupdateTreatmentSheetTreatmentSheetupdateTreatmentSheetCellTreatmentSheetCellupdateTreatmentSheetRowTreatmentSheetRowupdateTreatmentSheetStartTreatmentSheetupdateTreatmentSheetTemplateTreatmentSheetTemplateupdateTreatmentSheetTimeSlotsTreatmentSheetupdateTriggerTriggerupdateVendorVendorupdateViewerProviderupdateViewerPasswordProviderupdateVisitHeaderConfigVisitHeaderConfigupdateVitalsVitalsupdateVoiceCallVoiceCalluploadClinicImageLocationuploadEmailTemplateImageStringuploadEncounterTypeAssetStringuploadLocationLogoOrguploadMassInventoryMassUploadResultuploadMassProductsStringuploadMassRdvmsStringuploadOrgLogoOrguploadPatientDocumentPatientDocumentuploadPatientImagePatientuploadProtocolsMigrationCsvStringuploadProviderElectronicSignatureElectronicSignatureuploadProviderProfileImageProvideruploadRdvmDocumentRdvmDocumentupsertLowStockThresholdLowStockThresholdupsertPackageLocationMarkupLocationOrLocationTagupsertPatientContactDetailsPatientContactDetailsupsertProductConfigProductConfigupsertProductLocationMarkupLocationOrLocationTagupsertProductTypeLocationMarkupLocationupsertProviderAppointmentTypeLimitProviderAppointmentTypeLimitupsertProviderCommissions[ProviderCommission]upsertProviderPreferencesProviderPreferencesvalidateControlledDrugPinBooleanvaluesetLabelStringvoidPaymentPayment