Guides

Introduction GraphQL Guide

API Reference

Queries24▾

AccountsQueries AnalyticsQueries BillingQueries BoardQueries BoardingQueries ClinicalQueries ConversationsQueries EntitiesQueries EventsQueries HospitalQueries InventoryQueries LabQueries MarketingQueries NewBillingQueries NotificationsQueries PlanQueries RdvmsQueries RemindersQueries ScheduleQueries TasksQueries TelemedicineQueries TreatmentQueries TriggersQueries VoiceCallQueries

Mutations26▾

AccountsMutations AnalyticsMutations BillingMutations BoardMutations BoardingMutations ClinicalMutations CommentsMutations ConversationsMutations EntitiesMutations HospitalMutations InventoryMutations LabMutations LicenseMutations MarketingMutations NewBillingMutations NotificationsMutations PayrollMutations PlanMutations RdvmsMutations RemindersMutations ScheduleMutations TasksMutations TelemedicineMutations TreatmentMutations TriggersMutations VoiceCallMutations

Type System

Objects363▾

AccountCreditHistoryResponse AccountsReceivableBalance Address AdministrationRoute AgedAccountsReceivable AgedAccountsReceivableTotals AgedArReportGeneration AgedBucket AgedBucketConfig Alert Allergy AnalyticsData AnalyticsDataRow AnalyticsDataRowBreakdown ApiKey Appointment AppointmentIntakeData AppointmentReasonCategory AppointmentReminder AppointmentType AppointmentTypeTag ApptCountProviders ArReconciliation AsyncMedicalRecord Attachment AutoMessage AvailableTimeSlot BillingFrequencyOption BillingGroup BillingGroupConnection BillingGroupEdge BillingNote BoardCell BoardGroup BoardingCage BoardingWard BoardRow Cadence Cage CallLog CardconnectCardInfo CardconnectVerifyCredentialsResult CareTeamRole Changelog ChangelogConnection ChangelogEdge CheckboxDatum ChecklistDatum Client ClientConnection ClientConsent ClientEdge ClientExternalCommPreferencesValue ClientRdvm ClientReferralSource ClientResult ClientTag ClinicalNote Comment Complication Conditional ConsentForm Conversation ConversationPage Coowner CoownerBreakdown Coupon CouponProduct CreditMemo CreditMemoTotals CreditReason CreditReasonRelated Cursor CustomAppointmentField CustomAppointmentFieldValue CustomClientField CustomClientFieldValue CustomLocationAttribute CustomPatientField CustomPatientFieldValue CustomPatientProtocol CustomVital Dashboard DatasyncLog DatasyncRecords DateCount DeletionLog Department DetailedCreditItem DetailedCreditItemConnection DetailedCreditItemEdge DetailedSalesRevenueItem DetailedSalesRevenueItemConnection DetailedSalesRevenueItemEdge Diagnosis Diagnostic DiagnosticConnection DiagnosticEdge DialpadOffice DiscountReason DropdownDatum ElectronicSignature EmailStatus EmailTemplate EncounterTypeSectionOverride EntitiesTag EntityTag EntityTagGroup EntityValidation Estimate EstimateItem EstimatesTotals Event EventConnection EventEdge ExternalSearchResult ExtraField FeatureFlag FieldDatum FieldDatumPart File FileResults FormDatum FormulaDatum FulfillmentSource Highlight Hospitalization HospitalizationTask ImageDatum Immunization ImmunizationConnection ImmunizationDatum ImmunizationEdge ImportedEntity IntervalConfig InventoryAdjustment InventoryLevel InventoryLog LabDevice LabOrder LabResult LabResultImage LabTest LedgerEntry LedgerEntryTotals LegalEntity License LinkedClinicalNote Location LocationAttribute LocationChatMessage LocationChatNotification LocationClientAccountCredits LocationHours LocationKpi LocationProviderSchedule LocationSchedule LocationTag LowStockThreshold Macro ManualArAdjustmentResult MassUploadResult MasterProduct Medication MedicationConnection MedicationEdge MedicationIntegrationTransaction MedicationIntegrationTransactionConnection MedicationIntegrationTransactionEdge MedicationManufacturer MedicationsFilledReportItem MedicationsFilledReportResult MedicationsReportItem MedicationsReportResult MedicationStatusCount Message Modality MonitorDatum Monograph MonographGuide MonographSection Newsletter NoteDatum Notification NotificationMetadata NovaBoardCell NovaBoardRowCells NovaBoardSheet NovaBoardUpdatePayload ObanJob Order OrderFlag OrderItem OrderItemConnection OrderItemEdge OrderItemsTotals OrderPaymentMismatch OrdersCounts OrdersTotals Org OrgDepartment OrgLab OrgLabTypeMetadata OrgLabUpdateResult OrgPreference OutlookSyncResult Pack PageInfo Patient PatientClinicalItemsPendingApprovalCounts PatientCompliance PatientComplication PatientDiagnosis PatientDocument PatientDocumentConnection PatientDocumentEdge PatientPlan PatientPlanCharge PatientPlanItem PatientProtocol PatientTag Payment PaymentReason PaymentSource PaymentsTotals PendingImmunizationDatum PendingPackageDatum PendingRxDatum Permission PharmacySnapshot PhoneNumber PlanOption PlayPackDeferredRevenueItem PlayPackDeferredRevenueItemConnection PlayPackDeferredRevenueItemEdge PlumbsHandout PreventionPlan PriceChange PriceChangeFilter PriceTier PrintLabelResult PrintnodeComputersField PrintnodePrintersField Problem ProcessorPayment Product ProductCategory ProductConfig ProductDosageConfig ProductManufacturer ProductManufacturerPage ProductMetadataField ProductPackage ProductPackageItem ProductPrice ProductSpeciesDosageConfig ProductType Protocol ProtocolReminder ProtocolReminderByProtocol Provider ProviderAppointmentTypeLimit ProviderCommission ProviderConnection ProviderEdge ProviderPreferences ProviderPunch ProviderRole ProviderTransfer PurchaseOrder PurchaseOrderItem Rdvm RdvmContact RdvmDocument RdvmRecentPatients RdvmVisit ReconciliationNote Recurrence Relationship Reminder ReminderSilence ReorderQueueResult RepeatingEvent Reservation ReturnedOrderItem RevenueCenter RevenueCenterBudget RootMutationType RootQueryType RootSubscriptionType RowUploadError RxDatum ScheduleRecurrence ScheduleTemplate ScheduleTemplateRange SentAutoMessage SentReminder SketchDatum Species StockLocation StockTransfer StockTransferItem StockTransferNote StripeAddress StripeBillingDetails StripeCard StripeClientSecret StripeCustomer StripeInvoiceSettings StripePaymentIntent StripePaymentMethod StripePaymentTypeResult StripeReader StripeUsBankAccount SwapAppointmentResult SyncClientResult Task TaskCategory TaskConnection TaskEdge TaskGroup TeletailsSession TestResult TextDatum TimeSlot Treatment TreatmentConnection TreatmentDatum TreatmentEdge TreatmentInfo TreatmentSheet TreatmentSheetCareTeamMember TreatmentSheetCell TreatmentSheetCellComment TreatmentSheetRow TreatmentSheetRowAdditive TreatmentSheetRowAdditiveEntry TreatmentSheetRowBolus TreatmentSheetRowFluid TreatmentSheetTemplate TreatmentTimeInterval Trigger TriggerAddOrderItemOptions TriggerCreateTaskOptions TriggerDefaultOptions TriggerIgnoreProvider TriggerProduct TriggerSendEmailOptions TriggerWebhookOptions UsageReport UsageReportTotals ValuesetDatum ValuesetDatumOption Vendor VetspireSubscription VetspireSubscriptionTier Viewer Visit VitalDatum Vitals VitalsTemplate VoiceCall Weight

Unions4▾

Bill LocationOrLocationTag MessageSender Orderable

Input Objects224▾

AccountCreditHistoryOrderBy AccountsFilters AccountsOrderBy AddressInput AgedBucketConfigInput AgedBucketInput AlertInput AllergyInput AnalyticsFieldModifier AppointmentInput AppointmentIntakeDataInput AppointmentPositionInput AppointmentReminderInput AppointmentTypeInput AppointmentTypeTagInput ApproveCubexDiagnosticInput ApproveCubexEncounterProductInput ApproveCubexImmunizationInput ApproveCubexMedicationInput ApproveCubexTreatmentInput ApproveMedicationInput AssignOrphanTransactionInput AutoMessageInput BillingGroupFilters BillingGroupInput BillingGroupOrderBy BillingNoteInput BoardCellInput BoardingBlockInput BoardingCageInput BoardingWardFilters BoardingWardInput BoardRowInput CadenceInput CageInput CallLogInput ChangelogFilters ChangelogOrderBy ClientExternalCommPreferencesInput ClientFilters ClientInput ClientRdvmInput ClientReferralSourceInput ClientTagInput ClinicalNoteInput ComplicationInput ConditionalInput ConsentFormInput ConversationInput ConversationSetAttachment CoownerInput CouponInput CouponProductInput CreateCareTeamRoleInput CreateIguanaLabOrderInput CreateIguanaLabResultInput CreateManualArAdjustmentInput CreateProviderTransferInput CreateTreatmentSheetInput CreditMemoInput CreditReasonInput CustomAppointmentFieldInput CustomAppointmentFieldValueInput CustomClientFieldInput CustomClientFieldValueInput CustomLocationAttributeInput CustomPatientFieldInput CustomPatientFieldValueInput CustomPatientProtocolInput CustomTreatmentSheetRowInput CustomVitalInput DepartmentInput DiagnosticInput DiscountReasonInput DosageConfigInput EmailTemplateInput EncounterTypeSectionOverrideItemInput EntitiesTagInput EntityTagGroupInput EntityTagInput EntityValidationInput EstimateInput EstimateItemInput EventMetadataFilter EventsOrderBy ExternalSearchInput ExtraFieldInput Filter FulfillmentSourceInput HospitalizationInput HospitalizationTaskInput IguanaExamInput ImmunizationFilters ImmunizationInput ImportFromDocumentInput IntervalConfigInput InventoryAdjustmentInput LabOrderInput LabResultInput LicenseInput LinkedClinicalNoteInput LocationAttributeInput LocationFilters LocationHoursInput LocationInput LocationProviderScheduleInput LocationScheduleInput LocationTagInput LowStockThresholdInput MacroInput MedicationInput MedicationManufacturerInput MedicationPharmacyFieldsInput MedicationPharmacyStatusInput NewsletterInput NovaBoardFilters OrderFlagInput OrderInput OrderItemInput OrderLineItemsFilters OrderLineItemsOrderBy OrgDepartmentInput OrgInput OrgLabInput OrgPreferenceInput PatientDiagnosisInput PatientDocumentFilters PatientDocumentInput PatientDocumentOrderBy PatientFilters PatientInput PatientPlanFilters PatientPlanInput PatientPlanItemInput PatientRegistration PatientTagInput PaymentInput PaymentReasonInput PaymentSourceInput PharmacyMedicationsOrderBy PhoneNumberInput PlanOptionInput PreventionPlanInput PriceChangeFilterInput PriceChangeInput PriceTierInput PrinterInput ProblemInput ProductCategoryInput ProductConfigInput ProductInput ProductManufacturerInput ProductMetadataFieldInput ProductPackageInput ProductPackageItemInput ProductPriceInput ProductTypeFlags ProductTypeInput ProtocolInput ProtocolReminderInput ProviderAppointmentTypeLimitInput ProviderCommissionInput ProviderInput ProviderPreferencesInput ProviderPunchInput ProviderRoleInput ProvidersFilters ProvidersOrderBy ProviderViewerInput PurchaseOrderInput PurchaseOrderItemInput RdvmContactInput RdvmInput RdvmVisitInput ReconciliationNoteInput RecurrenceInput RelationshipInput ReminderInput ReminderSilenceInput RepeatingEventInput ReservationFilters ReservationInput RevenueCenterBudgetInput RevenueCenterInput SaveTreatmentSheetCellOrderItemInput ScheduleRecurrenceInput ScheduleTemplateInput ScheduleTemplateRangeInput SelectedItemsInput SpeciesDosageConfigInput StockLocationInput StockLocationUpdate StockTransferInput StockTransferItemInput StockTransferNoteInput SyncClientInput TaskCategoryInput TaskGroupInput TaskInput TasksFilters TasksOrderBy TeletailsSessionInput TreatmentInput TreatmentSheetCareTeamMemberInput TreatmentSheetCellInput TreatmentSheetInput TreatmentSheetRowAdditiveEntryInput TreatmentSheetRowAdditiveInput TreatmentSheetRowBolusInput TreatmentSheetRowFluidInput TreatmentSheetRowInput TreatmentSheetTemplateInput TreatmentTemplateSection TreatmentTimeIntervalInput TriggerInput UpdateCareTeamRoleInput UpdateIguanaLabOrderInput UpdateProviderTransferInput UpsertProductConfigInput VendorInput VisitItemInput VitalsInput VitalsTemplateInput VoiceCallInput

Enums105▾

ActionsEnum AddressUse AdminTag AgedArReportStatus AnalyticsBreakdown AnalyticsDataRowModifier AnalyticsField AnalyticsSegment AppointmentStatus ArBreakdown BillingGroupFeeType CadenceContactMethods CallLogOutcome CommentableEntityType Comparison ConditionalOperator ContactType ConversationMedium DayOfWeek DiagnosticStatus DiscountType DoubleBookingConstraint EncounterPdfType EncounterProductStatus EncounterSummaryDocumentType EstimateStatus EstimateType Eye FeatureFlagEnum FeeCalculationMethod FilterField IguanaLabOrderEventType IguanaRisOrderUpdateStatus ImmunizationStatus ImmunizationType ImportEntityType InferredResultTypes InvoiceSortFieldEnum InvoiceStatus IsoCountry LabelSize LicenseType MedicationStatus Month MonthlyDueDateType NotificationType NovaBoardCellStatus NovaBoardUpdateType ObanJobState OrderByDirection OrderByEnum OrgLabType OutlookSyncStatus PatientOrderByEnum PaymentMethod PaymentSort PharmacyRejectionReason PharmacyStatus PlanInterval PriceChangeFilterType PriceChangeStatus PriceChangeType PriceType PricingType ProblemType ProductApplicationType Pronouns PurchaseOrderStatus RecurrenceDeleteScope RecurrenceEditScope ReminderEvent ReminderType RepeatType ReportBreakdown ReportSegment ReservationCategory ReservationStatus ReservationStatusFilter ReservationTime ReturnedOrderItemType RouteType ScheduledDrugType Severity Sex SortFieldEnum SortOptions SortProductOptions StockTransferStatus StripePaymentType SubscriptionModel TimeSegment TreatmentSheetFormat TreatmentSheetRowFluidType TreatmentSheetSummaryType TreatmentSheetType TreatmentSheetUnits TreatmentStatus TriggeredProtocolsSortFieldEnum TriggerIf TriggerThen VisitItemType VisitType WastageReason WeekOfMonth WeightUnit

Scalars14▾

Boolean Date DateTime Decimal ID Int JSON NaiveDateTime Numrange Price String Time Truthy Upload

Home
/Objects
/AdministrationRoute

Object

AdministrationRoute

Usage Example

query {
  # Use this type in your queries
  someQuery {
  abbrev
  name
  }
}

Fields

abbrevString!required

nameString!required