Guides

Introduction GraphQL Guide

API Reference

🔍Queries24▾

✏️Mutations26▾

Type System

📦Objects337▾

AccountCreditHistoryResponse AccountsReceivableBalance Address AgedAccountsReceivable AgedAccountsReceivableTotals AgedArReportGeneration Alert Allergy AnalyticsData AnalyticsDataRow AnalyticsDataRowBreakdown ApiKey Appointment AppointmentIntakeData AppointmentReasonCategory AppointmentReminder AppointmentType AppointmentTypeTag ApptCountProviders ArReconciliation AsyncMedicalRecord Attachment AutoMessage AvailableTimeSlot 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 CreditMemo CreditMemoTotals 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 Encounter EncounterCareTeamMember EncounterConnection EncounterEdge EncounterProduct EncounterProductConnection EncounterProductEdge EncounterSection EncounterType EncounterVersion 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 ImmunizationDatum InventoryAdjustment InventoryBucket InventoryLevel InventoryLog LabDevice LabOrder LabResult LabResultImage LabTest LedgerEntry LedgerEntryTotals LegalEntity License LinkedClinicalNote LinkedEncounter Location LocationAttribute LocationChatMessage LocationChatNotification LocationClientAccountCredits LocationHours LocationKpi LocationProviderSchedule LocationSchedule LocationTag LowStockThreshold Macro MassUploadResult MasterProduct Medication MedicationConnection MedicationEdge MedicationIntegrationTransaction MedicationIntegrationTransactionConnection MedicationIntegrationTransactionEdge 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 OrgLabUpdateResult OrgPreference Pack PageInfo Patient PatientCompliance PatientComplication PatientDocument PatientDocumentConnection PatientDocumentEdge PatientPlan PatientPlanCharge PatientPlanItem PatientProtocol PatientTag Payment PaymentSource PaymentsTotals PendingImmunizationDatum PendingPackageDatum PendingRxDatum Permission PhoneNumber PlanOption PlumbsHandout PreventionPlan PriceChange PriceChangeFilter PriceTier PrintLabelResult PrintnodeComputersField PrintnodePrintersField Problem ProcessorPayment Product ProductCategory ProductManufacturer ProductManufacturerPage ProductMetadataField ProductPackage ProductPackageItem ProductPrice ProductType Protocol ProtocolReminder ProtocolReminderByProtocol Provider ProviderAppointmentTypeLimit ProviderCommission ProviderPreferences ProviderPunch ProviderRole ProviderTransfer PurchaseOrder PurchaseOrderItem Rdvm RdvmContact RdvmDocument RdvmRecentPatients RdvmVisit ReconciliationNote Recurrence Relationship Reminder ReminderSilence RepeatingEvent Reservation ReturnedOrderItem RevenueCenter RevenueCenterBudget RootMutationType RootQueryType RootSubscriptionType RowUploadError RxDatum ScheduleRecurrence ScheduleTemplate ScheduleTemplateRange SentAutoMessage SentReminder SketchDatum StockLocation StockTransfer StockTransferItem StripeAddress StripeBillingDetails StripeCard StripeClientSecret StripeCustomer StripeInvoiceSettings StripePaymentIntent StripePaymentMethod 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 TriggerProduct TriggerSendEmailOptions TriggerWebhookOptions UsageReport UsageReportTotals ValuesetDatum ValuesetDatumOption Vendor VetspireSubscription VetspireSubscriptionTier Viewer Visit VitalDatum Vitals VitalsTemplate VoiceCall Weight

🔗Unions4▾

Bill LocationOrLocationTag MessageSender Orderable

📥Input Objects199▾

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

🏷️Enums94▾

ActionsEnum AddressUse AdminTag AgedArReportStatus AnalyticsBreakdown AnalyticsDataRowModifier AnalyticsField AnalyticsSegment AppointmentStatus CadenceContactMethods CallLogOutcome CommentableEntityType Comparison ConditionalOperator ContactType ConversationMedium DayOfWeek DiagnosticStatus DiscountType DoubleBookingConstraint EncounterPdfType EncounterProductStatus EncounterSummaryDocumentType EstimateStatus EstimateType Eye FeatureFlagEnum FilterField ImmunizationStatus ImmunizationType InferredResultTypes InvoiceSortFieldEnum InvoiceStatus IsoCountry LabelSize LicenseType MedicationStatus Month NotificationType NovaBoardCellStatus NovaBoardUpdateType ObanJobState OrderByDirection OrderByEnum OrgLabType PatientOrderByEnum PaymentMethod PaymentSort 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 SubscriptionModel TimeSegment TreatmentSheetFormat TreatmentSheetRowFluidType TreatmentSheetSummaryType TreatmentSheetType TreatmentSheetUnits TreatmentStatus TriggeredProtocolsSortFieldEnum TriggerIf TriggerThen VisitType WastageReason WeekOfMonth WeightUnit

🔢Scalars14▾

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

Home
/Objects
/ExtraField

Object

ExtraField

Usage Example

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

Fields

labelString

nameString!required

typeString!required