Vetspire API
Guides
IntroductionGraphQL Guide
Queries
Mutations
EntitiesacquireFaxNumberacquireTollFreeNumberacquireTwilioPhoneNumberassignProviderToLocationcreateAlertcreateCagecreateClientRdvmcreateClientReferralSourcecreateConsentFormcreateCustomClientFieldcreateCustomLocationAttributecreateCustomPatientFieldcreateDepartmentcreateEmailAttachmentIntegrationcreateEntityValidationcreateLocationcreateLocationAttributecreateLocationTagcreateOrgDepartmentcreateOrgPreferencedeleteAlertdeleteCagedeleteClientRdvmdeleteClientReferralSourcedeleteConsentFormdeleteCustomClientFielddeleteCustomLocationAttributedeleteCustomPatientFielddeleteDepartmentdeleteEmailAttachmentIntegrationdeleteEntityValidationdeleteLocationdeleteLocationTagdeleteOrgDepartmentfileDownloadLinkloginGoogleCloudPrintmergeClientReferralSourcesremoveGoogleCloudPrintCredentialsreorderAlertsreorderClientReferralSourcessendLocationChatMessagesetChatLastReadAtsetDaycareOpenunassignProviderFromLocationupdateAlertupdateCageupdateClientRdvmupdateClientReferralSourceupdateConsentFormupdateCustomLocationAttributeupdateDepartmentupdateEmailAttachmentIntegrationupdateEntityValidationupdateLocationupdateLocationAttributeupdateLocationTagupdateOrgupdateOrgDepartmentupdateOrgPreferenceuploadClinicImageuploadLocationLogouploadOrgLogo
BillingaddCreditMemoaddLinkedProductaddOrderItemaddOrderItemToEncounteraddPackageToEncounteraddPackageToEstimateaddPackageToOrderaddPurchaseOrderItemaddToWishlistapplyAccountCreditbillingHistorybillingStatementconvertEstimateToOrdercreateOrdercreateProductcreateProductManufacturercreatePurchaseOrdercreateStripePaymentIntentcreditMemoPdfdeleteLinkedProductdeleteOrderdeleteProductdeleteProductManufacturerdeletePurchaseOrderdeletePurchaseOrderItemdeleteWishlistItememailBillingStatementsemailClientBillingStatementemailClientPaymentReceiptemailCreditMemoToClientemailEstimateToClientemailInventoryCsvemailInvoiceToClientemailProductsCsvendOfDayReportgenerateInvoicegroupOrderItemsByPatientinvoiceBarcodesPdfissueCreditDiscountmarkOrderUncollectiblenewVendororderWishlistpaymentReceiptPdfrefundOrderItemreopenOrderreorderEstimateItemsreorderOrderItemsreturnOrderItemsaveEstimatesendPaymentRequestupdateOrderupdateOrderItemupdateProductManufacturerupdateProductProductCategoryupdatePurchaseOrderupdatePurchaseOrderItemupdateVendorupdateWishlistItemuploadMassProductsupsertLowStockThresholdupsertPackageLocationMarkupupsertProductLocationMarkupupsertProductTypeLocationMarkup
ClinicaladdTreatmentapproveMedicationcaptureClientConsentclientConsentLinkcreateAllergycreateApptVitalscreateComplicationcreateCustomPatientFieldValuecreateCustomPatientProtocolcreateImmunizationcreateMacrocreateParentProblemcreatePatientcreatePatientTagcreateProblemcreateVitalsdeleteAllergydeleteClientConsentdeleteComplicationdeleteImmunizationdeleteMacrodeleteMedicationdeletePatientDocumentdeletePatientTagdeleteProblemdeleteVitalsemailEncounteremailEncounterPdfemailEncounterRecordemailEncounterRecordToCustomemailEncounterRecordToRdvmsemailHospitalizationNoticeToRdvmsemailImmunizationsRecordemailRabiesCertificateemailSelectedRabiesCertificatesencounterPdfgenVetsourceUrlmassMicrochipRegistermergePatientsmovePatientToClientprescribeMedicationprintLabelPrintnoderecordPatientWeightrefillMedicationregisterPatientMicrochipsaveMicrochipsendEstimateConsentDepositLinksendSurveyLinksignEncountersurgeryLogPdftransferPatienttriggerPrescriptionunassignProblemFromEncounterupdateAllergyupdateComplicationupdateCustomPatientFieldValueupdateCustomPatientProtocolupdateImmunizationupdateLinkedClinicalNoteupdateLinkedEncounterupdateMacroupdateMedicationupdatePatientupdatePatientDocumentupdatePatientTagupdateProblemupdateVitalsuploadPatientImagevaluesetLabel
NewBillingaddEstimateItemaddPackageToPackageapplyCouponapplyEstimateCouponautoApplyCouponsautoApplyEstimateCouponschargeClientchargeEstimatechargeOrdercopyPackagecreateBillingNotecreateCouponcreateEstimatecreateEstimateItemcreateOrderFlagcreateProductPackagecreateProductPackageItemcreateProductPricecreateReconciliationNotecreateRevenueCentercreateRevenueCenterBudgetdeclinePackagedeleteAppliedCoupondeleteAppliedEstimateCoupondeleteCoupondeleteEstimatedeleteEstimateItemdeleteOrderFlagdeleteOrderItemdeletePackagePackagedeleteProductPackagedeleteProductPackageItemdeleteProductPricedeleteRevenueCentermarkOrderPaidIfFullyPaidrefundPaymentupdateCouponupdateEstimateupdateEstimateItemupdateEstimateItemsupdateOrderFlagupdateOrderItemsupdatePaymentupdateProductupdateProductPackageupdateProductPackageItemupdateProductPriceupdateReconciliationNoteupdateRevenueCenterupdateRevenueCenterBudgetvoidPayment
NewBillingaddEstimateItemaddPackageToPackageapplyCouponapplyEstimateCouponautoApplyCouponsautoApplyEstimateCouponschargeClientchargeEstimatechargeOrdercopyPackagecreateBillingNotecreateCouponcreateEstimatecreateEstimateItemcreateOrderFlagcreateProductPackagecreateProductPackageItemcreateProductPricecreateReconciliationNotecreateRevenueCentercreateRevenueCenterBudgetdeclinePackagedeleteAppliedCoupondeleteAppliedEstimateCoupondeleteCoupondeleteEstimatedeleteEstimateItemdeleteOrderFlagdeleteOrderItemdeletePackagePackagedeleteProductPackagedeleteProductPackageItemdeleteProductPricedeleteRevenueCentermarkOrderPaidIfFullyPaidrefundPaymentupdateCouponupdateEstimateupdateEstimateItemupdateEstimateItemsupdateOrderFlagupdateOrderItemsupdatePaymentupdateProductupdateProductPackageupdateProductPackageItemupdateProductPriceupdateReconciliationNoteupdateRevenueCenterupdateRevenueCenterBudgetvoidPayment
Objects
AccountsReceivableBalanceAddressAlertAlertNotificationAllergyAnalyticsDataAnalyticsDataRowAnalyticsDataRowBreakdownApiKeyAppointmentAppointmentIntakeDataAppointmentReminderAppointmentTypeAppointmentTypeTagApptCountProvidersArReconciliationAsyncMedicalRecordAttachmentAutoMessageAvailableTimeSlotBillingNoteBoardCellBoardGroupBoardRowBoardingCageBoardingWardCadenceCageCallLogCardconnectCardInfoCheckboxDatumChecklistDatumClientClientConsentClientExternalCommPreferencesValueClientRdvmClientReferralSourceClientResultClientTagClinicalNoteCommentComplicationConditionalConsentFormConversationConversationPageCoownerCoownerBreakdownCouponCreditMemoCreditMemoTotalsCursorCustomClientFieldCustomClientFieldValueCustomLocationAttributeCustomPatientFieldCustomPatientFieldValueCustomPatientProtocolCustomVitalDatasyncLogDatasyncRecordsDateCountDeletionLogDepartmentDeprecatedVitalDatumDiagnosisDiagnosticDialpadOfficeDropdownDatumElectronicSignatureEmailAttachmentEmailAttachmentIntegrationEmailStatusEmailTemplateEncounterEncounterProductEncounterSectionEncounterTypeEncounterVersionEntitiesTagEntityTagEntityTagGroupEntityValidationEstimateEstimateItemEstimatesTotalsEventEventMetadataFilterPageExternalSearchResultExtraFieldFeatureFlagFieldDatumFieldDatumPartFileFileResultsFormDatumFormulaDatumFulfillmentSourceHighlightHospitalizationHospitalizationTaskImageDatumImmunizationImmunizationDatumInventoryAdjustmentInventoryBucketInventoryLevelInventoryLogLabDeviceLabOrderLabResultLabResultImageLabTestLedgerEntryLedgerEntryTotalsLegalEntityLicenseLinkedClinicalNoteLinkedEncounterLocationLocationAttributeLocationChatMessageLocationClientAccountCreditsLocationHoursLocationKpiLocationProviderScheduleLocationScheduleLocationTagLowStockThresholdMacroMassUploadResultMasterProductMedicationMedicationIntegrationTransactionMessageModalityMonitorDatumMonographMonographGuideMonographSectionRootMutationTypeNewsletterNoteDatumNotificationNotificationMetadataNovaBoardNovaBoardCellNovaBoardRowObanJobOrderOrderFlagOrderItemOrderItemsTotalsOrderPaymentMismatchOrdersTotalsOrgOrgDepartmentOrgLabOrgLabUpdateResultOrgPreferencePackPatientPatientCompliancePatientComplicationPatientDocumentPatientPlanPatientPlanItemPatientProtocolPatientTagPaymentPaymentSourcePaymentsTotalsPendingImmunizationDatumPendingPackageDatumPendingRxDatumPermissionPhoneNumberPlanOptionPlumbsHandoutPreventionPlanPriceChangePriceChangeFilterPriceTierPrintLabelResultPrintnodeComputersFieldPrintnodePrintersFieldProblemProcessorPaymentProductProductCategoryProductManufacturerProductManufacturerPageProductMetadataFieldProductPackageProductPackageItemProductPriceProductTypeProtocolProtocolReminderProtocolReminderByProtocolProviderProviderAppointmentTypeLimitProviderCommissionProviderPreferencesProviderPunchProviderRoleProviderTransferPurchaseOrderPurchaseOrderItemRootQueryTypeRdvmRdvmContactRdvmDocumentRdvmRecentPatientsRdvmVisitReconciliationNoteReminderReminderSilenceRepeatingEventReservationReturnedOrderItemRevenueCenterRevenueCenterBudgetRowUploadErrorRxDatumScheduleRecurrenceScheduleTemplateScheduleTemplateRangeSentAutoMessageSentReminderSketchDatumStripeAddressStripeBillingDetailsStripeCardStripeClientSecretStripeCustomerStripeInvoiceSettingsStripePaymentIntentStripePaymentMethodStripeReaderStripeUsBankAccountRootSubscriptionTypeSyncClientResultTaskTaskCategoryTaskGroupTeletailsSessionTestResultTextDatumTimeSlotTreatmentTreatmentDatumTreatmentInfoTreatmentSheetTreatmentSheetCellTreatmentSheetCellCommentTreatmentSheetRowTreatmentSheetRowAdditiveTreatmentSheetRowAdditiveEntryTreatmentSheetRowBolusTreatmentSheetRowFluidTreatmentSheetTemplateTreatmentTimeIntervalTriggerTriggerAddOrderItemOptionsTriggerCreateTaskOptionsTriggerDefaultOptionsTriggerProductTriggerSendEmailOptionsTriggerWebhookOptionsUsageReportUsageReportTotalsValuesetDatumValuesetDatumOptionVendorVetspireSubscriptionVetspireSubscriptionTierViewerVitalDatumVitalsVitalsTemplateVoiceCallWeightWishlistItem
Unions
BillLocationOrLocationTagMessageSenderOrderable
Input Objects
AddressInputAlertInputAllergyInputAnalyticsFieldModifierAppointmentInputAppointmentIntakeDataInputAppointmentReminderInputAppointmentTypeInputAppointmentTypeTagInputApproveMedicationInputAutoMessageInputBillingNoteInputBoardCellInputBoardRowInputBoardingBlockInputBoardingCageInputBoardingWardInputCadenceInputCageInputCallLogInputClientExternalCommPreferencesInputClientFiltersClientInputClientRdvmInputClientReferralSourceInputClientTagInputClinicalNoteInputComplicationInputConditionalInputConsentFormInputConversationInputConversationSetAttachmentCoownerInputCouponInputCreateProviderTransferInputCreditMemoInputCustomClientFieldInputCustomLocationAttributeInputCustomPatientFieldInputCustomPatientProtocolInputCustomVitalInputDepartmentInputDiagnosticInputEmailAttachmentIntegrationInputEmailTemplateInputEntitiesTagInputEntityTagGroupInputEntityTagInputEntityValidationInputEstimateInputEstimateItemInputEventMetadataFilterEventsPaginatedInputExternalSearchInputExtraFieldInputFilterFulfillmentSourceInputHospitalizationInputHospitalizationTaskInputImmunizationInputInventoryAdjustmentInputInventoryBucketInputLabOrderInputLabResultInputLicenseInputLinkedClinicalNoteInputLinkedEncounterInputLocationAttributeInputLocationFiltersLocationHoursInputLocationInputLocationProviderScheduleInputLocationScheduleInputLocationTagInputLowStockThresholdInputMacroInputMedicationInputNewsletterInputOrderFlagInputOrderInputOrderItemInputOrgDepartmentInputOrgInputOrgLabInputOrgPreferenceInputPatientDocumentInputPatientFiltersPatientInputPatientPlanFiltersPatientPlanInputPatientPlanItemInputPatientRegistrationPatientTagInputPaymentInputPaymentSourceInputPhoneNumberInputPlanOptionInputPreventionPlanInputPriceChangeFilterInputPriceChangeInputPriceTierInputPrinterInputProblemInputProductCategoryInputProductInputProductManufacturerInputProductMetadataFieldInputProductPackageInputProductPackageItemInputProductPriceInputProductTypeFlagsProductTypeInputProtocolInputProtocolReminderInputProviderAppointmentTypeLimitInputProviderCommissionInputProviderInputProviderPreferencesInputProviderPunchInputProviderRoleInputProviderViewerInputPurchaseOrderInputPurchaseOrderItemInputRdvmContactInputRdvmInputRdvmVisitInputReconciliationNoteInputReminderInputReminderSilenceInputRepeatingEventInputReservationFiltersReservationInputRevenueCenterBudgetInputRevenueCenterInputSaveTreatmentSheetCellOrderItemInputScheduleRecurrenceInputScheduleTemplateInputScheduleTemplateRangeInputSyncClientInputTaskCategoryInputTaskGroupInputTaskInputTeletailsSessionInputTreatmentInputTreatmentSheetCellInputTreatmentSheetInputTreatmentSheetRowAdditiveEntryInputTreatmentSheetRowAdditiveInputTreatmentSheetRowBolusInputTreatmentSheetRowFluidInputTreatmentSheetRowInputTreatmentSheetTemplateInputTreatmentTemplateSectionTreatmentTimeIntervalInputTriggerInputUpdateProviderTransferInputVendorInputVitalsInputVitalsTemplateInputVoiceCallInputWishlistItemInput
Enums
AddressUseAnalyticsBreakdownAnalyticsDataRowModifierAnalyticsFieldAnalyticsSegmentAppointmentStatusCadenceContactMethodsCallLogOutcomeCellStatusCommentableEntityTypeComparisonConditionalOperatorContactTypeConversationMediumDayOfWeekDiscountTypeDoubleBookingConstraintEncounterPdfTypeEncounterSummaryDocumentTypeEstimateStatusEstimateTypeEyeFeatureFlagEnumFilterFieldImmunizationStatusImmunizationTypeInferredResultTypesInvoiceSortFieldEnumInvoiceStatusIsoCountryLabelSizeLicenseTypeMedicationStatusObanJobStateOrderByEnumOrgLabTypePatientOrderByEnumPaymentMethodPaymentSortPlanIntervalPriceChangeFilterTypePriceChangeStatusPriceChangeTypePriceTypePricingTypeProblemTypeProductApplicationTypePronounsPurchaseOrderStatusReminderEventReminderTypeReportBreakdownReportSegmentReservationCategoryReservationStatusReservationStatusFilterReservationTimeReturnedOrderItemTypeRouteTypeSeveritySexSortFieldEnumSortOptionsSortProductOptionsSubscriptionModelTimeSegmentTreatmentSheetFormatTreatmentSheetRowFluidTypeTreatmentSheetSummaryTypeTreatmentSheetTypeTreatmentSheetUnitsTriggerIfTriggerThenTriggeredProtocolsSortFieldEnumWeightUnit
Scalars
BooleanDateDateTimeDecimalIDIntJSONNaiveDateTimeNumrangePriceStringTimeTruthyUpload

Object » Encounter

A clinical encounter

Fields

additionalProviders ([Provider])

appointment (Appointment)

category (String)

checkedInBy (Provider)

User who started encounter

clientConsents ([ClientConsent])

department (Department)

The department this encounter belongs to

diagnostics ([Diagnostic])+

encounterProducts ([EncounterProduct])+

encounterType (EncounterType)

encounterVersions ([EncounterVersion])

estimates ([Estimate])

historicalId (String)

id (ID!)

immunizations ([Immunization])+

insertedAt (NaiveDateTime)

intake ([Datum])

labOrders ([LabOrder])

labResults ([LabResult])

linkedClinicalNotes ([LinkedClinicalNote])

linkedEncounters ([LinkedEncounter])

location (Location)

medications ([Medication])+

metadata (JSON)

name (String)

A user-friendly name for this encounter, concatening its title and date

nextVisitDate (Date)

nextVisitReason (String)

order (Order)

org (Org)

patient (Patient)

patientComplications ([PatientComplication])

patientDocuments ([PatientDocument])

problems ([Problem])

provider (Provider)

Attending/signing provider

requiredSectionsNotFilledOut ([String])

scribedBy (Provider)

User who scribed the encounter

sections ([EncounterSection])

sectionsJson (String)

sharedAt (NaiveDateTime)

signed (Boolean)

signedDatetime (DateTime)

signer (Provider)

start (DateTime)

surveyLinkSent (Boolean)

tasks ([Task])

technician (Provider)

Technician

title (String)

treatments ([Treatment])+

updatedAt (NaiveDateTime)

vitals (Vitals)