Guides

Introduction GraphQL Guide

Queries

Notifications notifications unreadNotificationsCount

Board activeBoardRows boardCell boardGroups boardRow

Boarding boardingWards bookedDays reservationTypes reservations

Inventory clientConsent diagnostic fulfillmentSource fulfillmentSources inventoryAdjustments productCategories productCategory productType productTypes

Schedule appointment appointmentTypes appointments countAppointmentProviders countAppointments countViewerAppointments

NewBilling coupon coupons estimate estimateItems orderFlag orderFlags patientSubscription patientSubscriptions payment productPackage productPackages revenueCenter revenueCenterBudgets revenueCenters

Tasks overdueTasksCount task taskCategories tasks

Hospital macro macros

Reminders reminders

Triggers trigger triggers

Conversations conversation conversations unreadConversations unreadConversationsCount

Entities clientReferralSource clientReferralSources clientTag consentForm consentForms customClientFields customPatientFields encounterType location locationChatMessages locations org rdvm rdvms searchLocationTags searchPrinters searchRdvms

Lab getInhouseDevices labOrder labOrders labResult labResults orgLab orgLabOrders orgLabResults orgLabs

Accounts client clients clientsCount countNewClients provider providers searchAccounts totalClients viewer

Clinical allergies diagnostics encounter encounterSummary encounterTypes encounters encountersUpdatedSince immunization immunizationPdf immunizations medicalRecordsSummary medication medications patient patientConsentForms patientDocument patientLabel patients rabiesCertificate searchDiagnoses searchMacros totalPatients treatments vitals

Billing vendor orderItems inCollections searchVendors productsCount paymentsTotals estimates estimatesTotals product estimatePdf vendors searchInventoryBuckets ccTerminals packs order refundedOrderItems ordersTotals purchaseOrders processorPayments orders orderItemsTotals creditMemos searchProductTypes searchProductCategories purchaseOrder bills searchProducts invoicePdf products searchPackages payments creditMemosTotals hasBalanceDue

Plan patientPlans plan preventionPlan preventionPlans

Mutations

Hospital createClinicalNote createHospitalization createMacro deleteMacro updateClinicalNote updateEncounterType updateHospitalization updateMacro

Triggers createTrigger deleteTrigger updateTrigger

Boarding createReservation

Schedule createAppointment createAppointmentType createLocationProviderSchedule createLocationSchedule deleteAppointment deleteAppointmentType deleteLocationProviderSchedule deleteLocationSchedule makeAppointmentTypeDefault updateAppointment updateAppointmentIntake updateAppointmentType updateLocationHours updateLocationProviderSchedule updateLocationSchedule

Conversations createConversation sendMessage updateConversation

Reminders createReminder deleteReminder updateReminder

Plan cancelPlan enrollPlan

Payroll clockIn clockOut createProviderPunch updateProviderPunch

Board addPatientToBoard completeBoardCell createBoardCell invoiceBoardRow promoteEstimateToBoard uncompleteBoardCell updateBoardCell updateBoardRow

Inventory createDiagnostic createFulfillmentSource createInventoryAdjustment createProductCategory createProductType deleteDiagnostic deleteFulfillmentSource deletePendingInvoiceItem deleteProductCategory deleteProductType generateInventoryReport updateDiagnostic updateFulfillmentSource updatePendingInvoiceItem updateProductCategory updateProductType

Notifications deleteNotification readAllNotifications readNotification

Comments comment

Lab createOrgLab deleteLabOrder deleteLabResult deleteOrgLab finishLabOrder orderLab refreshLabResult updateLabOrder updateOrgLab

Tasks assignProviderToTask createTask createTaskCategory deleteTaskCategory unassignProviderFromTask updateTask updateTaskCategory

Accounts addClientAddress addClientStripeInfo addCoowner createBridgeUser createClient createClientTag createCustomClientFieldValue createProvider deleteAddress deleteClientTag deleteCoowner mergeClients removeClientStripeInfo resendVerification sendClientCheckinLink updateAddress updateClient updateClientTag updateCoowner updateCustomClientFieldValue updatePhoneNumber updateProvider updateViewer updateViewerPassword uploadProviderElectronicSignature uploadProviderProfileImage

NewBilling createCoupon addPackageToPackage deleteAppliedCoupon chargeClient createProductPackage deleteEstimate createRevenueCenter deleteEstimateItem updateEstimateItem createRevenueCenterBudget deleteProductPackageItem deleteRevenueCenter chargeEstimate createEstimate renewSubscription reinstateSubscription voidPayment deleteProductPackage deleteOrderFlag reorderPackageItems refundPayment updateOrderFlag updateProductPackage createOrderFlag createBillingNote updateRevenueCenter applyCoupon updateProductPackageItem deletePackagePackage deleteCoupon updateEstimate updateRevenueCenterBudget createEstimateItem updateCoupon createProductPackageItem updatePayment chargeOrder

Clinical updateVitals createParentProblem updateCustomPatientFieldValue captureClientConsent createAllergy emailImmunizationsRecord deleteMedication updatePatientDocument unassignProblemFromEncounter updateEncounter massMicrochipRegister createCustomPatientFieldValue prescribeMedication createPatient newEncounter updateMedication registerPatientMicrochip updateAllergy createImmunization updateProblem createEncounterType uploadPatientImage refillMedication updatePatient createProblem mergePatients signEncounter emailInvoiceToClient recordPatientWeight emailRabiesCertificate emailEncounterRecordToRdvms createEncounterOrder emailEstimateToClient copyFromPreviousEncounter addTreatment updateImmunization copyMedicationsToEncounter assignProblemToEncounter deleteProblem emailEncounterRecord uploadPatientDocument deleteAllergy deleteEncounter deletePatientDocument printMedicationLabel

Entities deleteEncounterType createOrgPreference updateRdvm updateCustomLocationAttribute updateLocation uploadOrgLogo createClientRdvm deleteCustomClientField createCustomLocationAttribute updateClientRdvm removeGoogleCloudPrintCredentials deleteConsentForm updateLocationAttribute createClientReferralSource uploadLocationLogo acquireTwilioPhoneNumber addOrgPaymentSource removeOrgPaymentSource deleteLocation assignProviderToLocation updateOrgPreference createCustomClientField makeLocationDefault deleteCustomLocationAttribute createLocationAttribute updateClientReferralSource createRdvm deleteClientReferralSource loginGoogleCloudPrint createCustomPatientField createLocation updateConsentForm updateOrg sendLocationChatMessage deleteClientRdvm deleteRdvm createConsentForm deleteCustomPatientField unassignProviderFromLocation

Billing deletePurchaseOrderItem generateInvoice orderWishlist convertEstimateToOrder upsertProductLocationMarkup createProduct addPackageToOrder updateVendor addOrderItem addLinkedProduct refundOrderItem reorderOrderItems subscribePatients reopenOrder updateProduct addOrderItemToEncounter deleteOrderItem updateOrder deleteProduct deleteLinkedProduct deleteOrder updateLocationDistribution deletePurchaseOrder updatePurchaseOrder addPackageToEncounter invoiceBarcodesPdf createOrder updatePurchaseOrderItem cancelSubscriptionSilently billingStatement updateProductProductCategory newVendor endOfDayReport cancelSubscription addPurchaseOrderItem addCreditMemo updateWishlistItem invoicePendingItems deleteWishlistItem addPackageToEstimate updateOrderItem addToWishlist applyAccountCredit createPurchaseOrder

Objects

AppointmentType Notification InventoryBucket RootMutationType PendingImmunizationDatum PhoneNumber ValuesetDatumOption ProductCategory OrgSubscription RevenueCenterBudget PendingPackageDatum TriggerAddOrderItemOptions EncounterSection OrgLab ConsentForm Provider CustomLocationAttribute LocationSchedule EncounterProduct AppointmentIntakeData InventoryLevel ProcessorPayment ElectronicSignature PurchaseOrder RxDatum DropdownDatum PatientPlanItem OrderFlag Diagnosis PatientDocument OldDatum Viewer Macro LocationChatMessage ClientRdvm ClinicalNote BoardCell PaymentSource Message BoardingWard Trigger Encounter ClientConsent Cage ValuesetDatum BoardRow PendingRxDatum Rdvm CustomPatientField ClientTag PrintLabelResult Client AvailableTimeSlot OrderItemsTotals TextDatum ProductType ProviderRole OrgPreference LocationAttribute LabDevice BoardingCage Patient PlanOption Payment OrdersTotals ApptCountProviders Estimate Coowner NoteDatum Reminder Conversation Location FieldDatum PurchaseOrderItem ClientResult Order Allergy Event ClientReferralSource ProductPackageItem ProductPackage VitalsTemplate Reservation CustomVital NotificationMetadata PendingInvoiceItem OrderItem Immunization PatientPlan TriggerWebhookOptions BillingNote RepeatingEvent CustomPatientFieldValue RevenueCenter FulfillmentSource EstimateItem RootQueryType PatientSubscription LabOrder Vitals Treatment AnalyticsDataRow PreventionPlan FormulaDatum Comment Org LocationDistribution TreatmentDatum AnalyticsDataRowBreakdown Highlight EncounterType BoardGroup Problem Product EstimatesTotals SketchDatum CreditMemoTotals Hospitalization ApolloAudience AnalyticsData TriggerDefaultOptions CustomClientFieldValue Address WishlistItem Task TriggerCreateTaskOptions Diagnostic PaymentsTotals PrintersField Coupon ReservationNightlyPrice LocationProviderSchedule Weight Attachment AutoMessage TriggerSendEmailOptions DateCount Medication ReservationType Appointment Pack LabResult VitalDatum LocationHours ImmunizationDatum CreditMemo InventoryAdjustment EmailTemplate TaskCategory ProviderPunch TestResult Vendor CustomClientField

Unions

EncounterOrEstimate Bill MessageSender

Input Objects

AnalyticsFieldModifier HospitalizationInput DiagnosticInput RevenueCenterBudgetInput PlanOptionInput ProductInput LocationScheduleInput AppointmentIntakeDataInput ClientFilters OrderInput RdvmInput Filter PatientRegistration ClientReferralSourceInput LocationInput OrderFlagInput CreditMemoInput LocationAttributeInput PurchaseOrderItemInput ProductTypeInput TriggerInput PurchaseOrderInput OrgLabInput PatientInput PaymentInput TreatmentInput ApolloAudienceInput EstimateItemInput AddressInput ProductTypeFlags OrgInput CustomVitalInput FulfillmentSourceInput CouponInput RevenueCenterInput ClinicalNoteInput InventoryBucketInput RepeatingEventInput ReminderInput ProductCategoryInput LowStockThresholdInput EstimateInput WishlistItemInput ProductPackageInput AllergyInput BoardCellInput TaskCategoryInput ImmunizationInput PrinterInput EncounterTypeInput PendingInvoiceItemInput ProductPackageItemInput CustomLocationAttributeInput ProviderRoleInput ReservationInput ClientRdvmInput AppointmentTypeInput ClientTagInput AutoMessageInput VendorInput ProviderInput LocationFilters OrgPreferenceInput LocationHoursInput TaskInput PhoneNumberInput ProviderViewerInput CustomClientFieldInput VitalsInput ClientInput CustomPatientFieldInput PatientDocumentInput ConsentFormInput EncounterInput VitalsTemplateInput MacroInput BillingNoteInput ClientsTagsInput PatientFilters CoownerInput AppointmentInput MedicationInput ProviderPunchInput LocationProviderScheduleInput PaymentSourceInput InventoryAdjustmentInput ProblemInput EmailTemplateInput ConversationInput EventMetadataFilter EncounterProductInput LabOrderInput BoardRowInput OrderItemInput

Enums

PlanInterval ImmunizationType PaymentMethod PurchaseOrderStatus DiscountType ImmunizationStatus AnalyticsBreakdown OrgLabType AnalyticsSegment Comparison InvoiceStatus TimeSegment TriggerIf AnalyticsDataRowModifier SortOptions Sex ProductApplicationType TriggerThen ConversationMedium CommentableEntityType ReminderType EncounterTypeEnum MedicationStatus AddressUse ReminderEvent ProblemType FilterField WeightUnit AppointmentStatus AnalyticsField EstimateType

Scalars

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

Input Object » ReservationInput

Fields

boardingCageId (ID)

endDate (Date)

locationId (ID)

notes (String)

patientId (ID)

startDate (Date)