Schema Reference
Queries
advanceAppointmentPrices Fetch advance appointment prices
allergySuggestions Search results for allergies, allergens, and reactions
announcement Fetch an announcement
announcements Fetch an array of announcements for a provider
announcementsCount Number of announcements for a provider
apiKeys Fetch paginated API Keys collection
apiKeysCount Number of API Keys
appliedTag An applied tag to a user
appliedTags Applied tags to a users
appointment fetch an appointment by id, group appointments are (considered public)
appointmentBookingWarnings Return potential booking issues for an appointment, date, time, repeats, attendees, and provider.
appointmentFrequencyData returns metadata about appointments for provider dashboard
appointmentInclusion fetch an appointment by id, group appointments are (considered public)
appointmentLocation fetch an appointment location by id (considered public)
appointmentLocations get appointment locations that the current user can use. (considered public)
appointmentNumberPerDayOfMonth Returns a json hash of the number of appointments in each day of the month. The month is the month that the passed day is in.
appointmentRequest Fetch a single appointment requests for a provider or organization
appointmentRequests Fetch a collection of appointment requests for a provider or organization
appointmentSetting fetch a Appointment Setting by id (considered public)
appointmentType fetch an appointment type by id (considered public)
appointmentTypeCreditChanges Fetch credit history for the specific appointment type
appointmentTypes Fetch paginated Appointment Type collection (considered public)
appointmentTypesCount Number of appointment types (considered public)
appointmentWorkflowStatuses Fetch paginated appointment workflow statuses collection
appointments Fetch paginated appointment collection
appointmentsCount Number of Appointments
appointmentsSummary Data summary for appointment reports
assumedBrand Get the assumed brand for the current user
auditLog Fetch paginated audit log.
autoTaskGenerators fetch auto task generators belonging to a specific user
automatedInsuranceBillingSetting fetch the automated insurance billing setting
availabilities Fetch availabilities for range
availabilitiesCount number of availabilities
availability Fetch availability
availabilitySummaryJson (Limited availability, subject to breaking changes). JSONified Hash with summary of availability.
availableItemTypes Fetch available item types (for use in onboarding items)
availableSlotsForRange Get open appointment times for a date range. Returns array of dates sorted in ascending order (considered public)
baseCms1500ForUser Get the Cms1500 Policies object for a given claim and client
basicUserInfoFromToken Get basic info about User from signup token
billableIcdCodes deprecated DEPRECATED: All ICD Codes that are allowed to be used in healthcare claims
billingItem fetch a billing item by id
billingItems Fetch paginated billing items collection
billingItemsCount Number of billing items
brand fetch a Brand by id (considered public)
brandFromCustomSignInPath fetch a Brand by custom sign in path (considered public)
brandInfo get info used on authentication pages for either a dietitian or partner
calendarViewSetting Fetch a calendar view settings for current user
canCapOfferingPurchases Check if the user has access to the package buy limit feature
canInvoiceSenderSeeRecipient Check if provider has access to client
candidHealthConnection fetch the current users candidhealth connection
cardIssues Fetch paginated stripe customer accounts with associated errors or soon to expire credit cards
cardIssuesCount Fetch paginated stripe customer accounts with associated errors or soon to expire credit cards
carePlan fetch a single care plan
carePlans Fetch paginated care plan collection
carePlansCount Number of care plans
carePlansTemplatesCount Number of care plans templates
cdaActivityEvents Fetch list of patient-initiated CDA activity events
changeClaimSubmitter fetch the current users Change Health connection
chargeBack fetch a chargeback by the Healthie ID or the Stripe Dispute ID.
chargeBacks fetch all charge backs for a user or organization
chargeBacksCount fetch count of all charge backs
chargeDisputes Fetch Stripe Charge Disputes for an organization
chartNotes Load all charting notes accessible by this user
chartNotesCount Count of charting notes accessible by this user
chartingItems All items to include in the charting list
chartingItemsCount All items to include in the charting list
chartingNoteAddendum Fetch a charting note addendum by id
chatSetting fetch a Chat Setting
closeToCurrentVideoChats get current video chats for a user.
cms1500 Fetch a CMS1500 by ID
cms1500s Fetch paginated Cms1500s collection
cms1500sCount Number of Cms1500s
colorCodeOptions Color Code Options for a given category
comment Fetch comment
comments Fetch comments collection
commentsCount number of comments
completedCourseItem fetch a completedCourseItem by course_item_id and user_id
completedOnboardingItem Get the completed onboarding item by ID
contactTypes All Contact Types For Current User
conversation fetch a conversation by id
conversationMembership fetch a conversation membership by id
conversationMembershipInvitees fetch a conversationmembership by id and invitees
conversationMemberships Fetch paginated conversation memberships collection
conversationMembershipsCount Number of conversationmembership
conversations Fetch current user's conversations. It is normally better to use the conversationMemberships query.
conversationsCount Number of conversation
course fetch a course by id (considered public)
courseClients fetch clients belonging to a course by course_id
courseClientsCount total number of clients for a specific course
courseCompletionInfo Get course completion info for users and user_groups
courseGroupClients Course group memberships for the course
courseGroupClientsCount Total clients in course group memberships
courseItem fetch a courseitem by id (considered public)
courseItemCustomEmails get all custom custom emails for a current user
courseItemDocuments get all documents for current user, can optionally include the attached org document by providing course_id and course_item_id.
courseItemForms get all custom module forms for a current user
courseItems Course items info for the course membership
courseMembership fetch a courseMembership by id
courseMemberships Fetch paginated course membership collection
courseMembershipsCount Number of course memberships
courses Fetch paginated course collection
coursesCount Number of course
cptCodes All CPT Codes
cptCodesCount CPT Codes count
currentUser fetch the current user.
currentUserNotificationsCount fetch the current users notifications count.
currentVideoChats get current video chats for a user.
customEmail Custom Email object
customEmailPreview A HTML string containing mailer template for certain email type
customEmails Fetch paginated custom emails collection
customEmailsCount Number of custom emails
customModuleForm fetch a custom module form by ID (templates are considered public)
customModuleForms All form templates for the current user
customModuleFormsCount Fetch paginated count for provider custom module forms
daysAvailableForRange get open appointment times for a range (considered public)
document fetch a document by id
documentViewings Get Document Viewings for a specific document. A 'View' is when a document is downloaded or opened in a new tab
documentViewingsCount Number of instances for a document viewings for a specific document
documents Fetch paginated documents collection
documentsCount Number of documents
dosespotUserInfo Fetch User Info on DoseSpot Object
dosespot_ui_link Fetch the iframe link to prescribe for a given patient (patient must have valid phone_number, dob, location.line1, location.city, location.state, and location.zip)
draft draft by conversation_membership id
drugAllergen Fetch an allergen by ID
drugAllergens Search for allergens by name
dsiComment Fetch DSI comment for given intervention_type
dynamicLink Fetch a link from Fullscript to create a treatment plan for a given user
embedWidgetSteps fetch embed steps based off of params
entries Fetch paginated entries collection
entriesCount Number of entries
entry fetch an entry by id
externalCalendars Fetch paginated external calendars collection
featureFlags Get the listed values of feature flags for the current user
featureToggle fetch a featureToggle by id
featureToggleForEditing fetch a featureToggle by id
folder fetch a folder by id
folders Fetch paginated folders collection
foldersCount Number of folders
foodSearch Fetch food items
foodSearchCount Get size of food items that matches the keyword
formAnswerGroup Fetch a form answer group by id
formAnswerGroups All filled forms for a given set of arguments
formAnswerGroupsCount The number of filled forms for a given set of a arguments
formHistories Form histories owned by a patient and related to a sourceable form (RequestedFormCompletion / OnboardingItem)
formHistoriesCount Total count of form histories owned by a patient and related to a sourceable form (RequestedFormCompletion / OnboardingItem)
formTypesToRequest Fetch available forms to request
fullscriptPractitionerTypes Fullscript practitioners that share the same clinic id as organization owner
fullscriptPractitioners Fullscript practitioners that share the same clinic id as organization owner
goal fetch a goal by id
goalHistories All completed goals for a given set of users
goalHistoriesCount All completed goals for a given set of users
goalHistory Fetch goal history
goalInstances A goal's instances
goalInstancesCount Number of instances for a goal
goalTemplates Goal templates for given user
goalTemplatesCount Number of Goal templates for given user
goals All goals, either for a given user or for all of the providers clients
goalsCount Number of goal
goalsData All goals data
goalsOverallCompletionRateInfo Overall completion percentage of goals
goalsStreakCount Overall completion percentage of goals
hasConditionalQuestionEditing When true, the user can set up question conditions in the form builder
hasFormsToComplete Checks if the specified user has any forms to complete.
hasSubLabels When true, the user can add sublabels to questions in the form builder
healthAssessment Fetch a single health assessment
healthAssessments Fetch Health Assessments
icdCode Fetch ICD Code by ID
icdCodes All ICD Codes
icdCodesCount Count of all ICD Codes
importDataRequest fetch import data request by user_id
initialCms1500 A new CMS1500 form with some objects already prefilled
initialFormAnswers Initial form answers for a given user and template
initialServiceDate Initial date of service for a new form answer group
initializedOfferingIncludes appointment types related to offering
insuranceAuthorization Insurance Authorization belonging to a client
insurancePlans Get all potential insurance plans
insurancePlansCount Get all potential insurance plans
intakeFlow Fetch intake flow
integrationsList Fetch list of available integrations
invoiceBasePrice get the base price for the invoice based off the associated item
labFiltersData Get options for lab filters
labOptions Fetch all lab options (considered public)
labOrder Fetch onboarding flows collection
labOrders Fetch lab orders collection
labOrdersCount Number of lab orders related to the current user
labResult Fetch a laboratory result by ID
lastCM Fetch most recent conversationMembership
lastClientActivities The 6 most recently active clients
loadMoreNotesCalled has loadMoreNotes been called
location fetch a location by id
locationResources Get location resources
locations Get locations for a given user (or current user)
locationsCount A count of available locations for the current user
mealSearch Fetch user meals
mealSearchCount Get size of user meals that matches the keyword
meal_plan_options Meal plan options from user Living Plate account. Nil if no Living Plate account associated
medication Fetch a medication by ID
medication_options Fetch an array of medications options. Considered Public
medications Fetch an array of medications for a given patient
medications_count Fetch count of medications for a given patient
metricGraphData Fetch data for the metric graphs for a given user
metricGraphsData Fetch data for the metric graphs for a given user
monthlyBillingItemsData returns metadata about monthly payments
multiLineMetricGraphData Fetch data for multi line metric graphs for a given user
newClientPriceString String containing info for the user about the client upgrade price
newOrganizationPriceString String containing info for the user about the org upgrade price
newOrganizationSupportPriceString String containing info for the user about the org upgrade price when adding a new support user
nextAppointment Fetch closest appointment
nextAvailableSlot get open appointment times for a range (considered public)
nextCourseItem fetch a courseitem by id (considered public)
note fetch a note by id
noteViewedStatus get the viewed status of a note
note_scheduler Fetch note scheduler by id
notes Fetch paginated note collection for given conversation
notesCount Number of notes
notificationCount get count of notifications for a given user (or for the current user)
notificationSetting fetch a Notification Setting by id
notifications get notifications for a given user (or for the current user)
offering fetch an offering by id (considered public)
offeringBillingItems Fetch paginated list of users associated with an offering
offeringBillingItemsCount Number of users associated with an offering
offeringCoupons Fetch paginated coupon offerings collection
offeringCouponsCount Number of offering coupons
offeringGroupVisibilities get all user groups relating to offerings
offeringImages All OfferingImage that have no user_id
offerings Fetch paginated offerings collection (considered public)
offeringsCount Number of offerings (considered public)
offeringsData returns metadata about offerings purchased
officeallySftpAccount fetch the current users officeally sftp connection
onboardingFlow Fetch an onboarding flow by id or uuid
onboardingFlows Fetch onboarding flows collection
onboardingFlowsCount Number of onboarding flows
onboardingItem fetch an onboarding item by id (considered public)
orgProvidersCptCodes Returns all cpt codes associated with org providers
organization fetch an organization by id, by provider id, or by the current_user, demographic org info is (considered public)
organizationCptCode Returns organization cpt code object
organizationFeeScheduleCptCode Fetch CPT code and fee schedule pricing by CPT code ID
organizationFeeScheduleCptCodes Provides CPT codes for an organization as configured in their fee schedule
organizationInfo Fetch organization info by id
organizationMembers fetch members of organization
organizationMembersCount org members count
organizationMembership Get the organization membership info of the current user, basic org member info is (considered public)
organizationMemberships Get the organization memberships
otherIdNumber fetch an Other Id Number by id
otherIdNumbers A collection of Other ID's and its Qualifiers for given user
paginate_transfers returns true if the there are more transfers to load
pdfLetterheadTemplatePreview PDF Letterhead HTML String. Falls back to the system default template unless `pdf_letterhead_template_id` is given
permissionTemplate Fetch permission template
permissionTemplates Get Permission Templates
permissionTemplatesCount Number of permission templates
pharmacies Fetch an array of pharmacies given search parameters
pharmacy Fetch a pharmacy given dosespot pharmacy id
placeOfServices fetch all place of services
plan fetch a Plan by id (considered public)
policy fetch a policy by id
preferred_medical_codes Fetch collection of preferred CPT/ICD codes
prescription Fetch a prescriptions for a given patient and prescription id pulled from Dosespot
prescriptions Fetch an array of prescriptions for a given patient pulled from Dosespot
prevCourseItem fetch a courseitem by id (considered public)
products Fetch paginated product collection
productsCount Number of products
provider fetch a provider by id
providerAcceptedInsurancePlan Fetch a single accepted insurance plan for a provider
providerAcceptedInsurancePlans Accepted insurance plans for a provider
providerAppointmentLocations get provider appointment locations.
providerCptCodes Returns all cpt codes associated with this provider
questionBankModules Fetch generic custom modules for use in the form builder
receiptLineItems Fetch receipt_line_items collection by super_bill_id
receivedDirectMessage Fetch received direct message via ID
receivedDirectMessages Fetch Received Direct Messages
receivedDirectMessagesCount Fetch number of Received Direct Messages
receivedFax Fetch Received Fax by ID
receivedFaxes Fetch paginated Received Faxes collection
receivedFaxesCount Number of Received Faxes
recentFoods Fetch recent food items
recurringForms Fetch recurring forms collection
recurringPayment Fetch a recurring payment by id
recurringPayments Fetch active recurring_payments
referral Fetch Referral by ID
referringPhysician Get referring physician based on id
referringPhysicians all referring physicians based on current user
referringPhysiciansCount Number of referring physicians
requestedFormCompletion fetch a requested form completion by id
requestedFormCompletions Fetch requested form completions collection
requestedPayment fetch a requested payment (invoice) by id
requestedPayments Fetch paginated Requested Payments collection
requestedPaymentsCount Number of Requested Payments
savedFilter Fetch specific saved filter
savedFilters Fetch all saved filters for a user or organization
scheduledMessageBlasts Fetch user's scheduled message blasts
scheduledUserPackageSelections Fetch collection of all scheduled packages
sdkConfig SDK configuration
sentDirectMessage Fetch sent direct message via ID
sentDirectMessages Fetch number of Sent Direct Messages
sentDirectMessagesCount Fetch number of Sent Direct Messages
sentFax Fetch sent Fax by ID
sentFaxes Fetch paginated Sent Faxes collection
sentFaxesCount Number of Sent Faxes
sentNotificationRecords Fetch notification list for a specific client or list of clients.
sentNotificationRecordsCount Get number of SentNotificationRecord entries
sentWebhooks Fetch paginated SentWebhooks collection. SentWebhook records are available for 180 days.
sentWebhooksCount Number of SentWebhooks. SentWebhook records are available for 180 days.
servingSizes Fetch serving sizes for a food
shareNotePreview A HTML string of charting note answers
showScheduledTab Should current user see scheduled chat tab
signedStreamName Get the signed stream name for a given stream name
smartPhrases Fetch user smart phrases
smartPhrasesCount Get size of user smart phrases that matches the keyword
startingSuperBillCptCodes initial cpt codes for a new super bill
startingSuperBillIcd10s initial icd10 codes for a new super bill
stateLicenses Return providers' state licenses
stripeBankAccount Default Stripe bank account object associated to a practitioner stripe account
stripeCompany Information about the user's stripe company
stripeCountries An array containing information about countries that stripe supports
stripeCountry An object containing info about a country that stripe supports
stripeCustomerDetails Fetch all stripe payment cards for user
subGoals All subgoals for a given goal
subGoalsCount Number of subgoals
subscription Get the current users subscription
superBill fetch a superbill by id
superBills Fetch paginated super bills collection
superBillsCount Number of super bills
surescriptsReportedMedicationHistory Fetch an array of medications from the Surescripts history (via Dosespot). Note patient consent needs to be confirmed via the API prior.
tags A collection of tags related to current patient/provider/organization
tagsCount Number of tags
tasks All tasks assigned to a provider or client
tasksCount All tasks assigned to a provider or client
timesForRange deprecated transactions fetch transactions for the current user
transfers fetch transfers for the current user
treatmentPlans Fetch an array of treatment plans and recommended products from Fullscript given a user id
unassociatedCompletedOnboardingItems Get the users completed onboarding items, that are not part of the users current flow
ungroupedCourseMemberships fetch ungrouped course memberhips belonging to a a specific course
ungroupedCourseMembershipsCount count of ungrouped course memberhips for a specific course
user fetch a user by id
userGroup fetch a user group by id
userGroups Fetch paginated user groups collection
userGroupsCount Number of user groups
userPackageSelections Fetch collection of all purchased packages
users Fetch paginated patients collection (use organizationMembers query for providers)
usersCount Number of users
validateCoupon Check if a coupon is valid, and return the new price (considered public)
validateResetPasswordToken Check if a reset passwrd token is valid
validateSignupToken Check if a signup token is valid
visualizeDashboard Fetch static Visualize dashboard by type
webhookEventTypes Fetch possible Webhook event types
webhooks Fetch paginated Webhooks collection
webhooksCount Number of Webhooks
whitelabelSetting Whitelabel setting to use
writeOff Fetch Write Off by ID
zoomSdkJwt Generate a JWT to be used in the client-side Zoom SDK. This is just available on production, and requires your account to be approved by Healthie. The JWT is valid for 1 day.
Mutations
addPharmacy Add a pharmacy to the user
bulkApply Apply selected tags on a specific user
bulkApplyCarePlanTemplate Apply care plan to the passed array of clients and/or groups
bulkCreateAvailability bulk create Availability
bulkCreateEntries creates bulk Entries (intended for apple health only for the time being)
bulkDeleteTasks Delete tasks
bulkUpdateCardIssues Update unseen card issues on a provider
bulkUpdateCarePlanUsers Trigger notification email or care plan activation for each user related to the selected care plans. In case of activation, a group care plan will be activated for each user of user_group(unless a user already have an active care plan). If you want to activate selected care plan for only one user(user of group) use ToggleCarePlanStatusForSpecificUser mutation
bulkUpdateClients Update multiple clients at once. Will change user group for multiple clients if user_group_id passed, otherwise clients will be archived
cancelRecurringPayment Cancels the recurring payment for a patient.
changeDevicesAvailability disabled devices in video chat
clearUnreconciledObjects Delete unreconciled allergies/problems/medications
completeCcdaReconciliation Complete a CCDA Reconciliation, based on user choice
completeCheckout Complete the checkout for booking or buying
completeCourseDocument Create CompletedCourseItem for related document
convertGeneratedFormAnswerGroup Converts a generated form answer group to a form answer group
copyCourse Copy a Course
copyCustomModule Copy Custom Module
copyCustomModuleForm copy Custom Module Form
copyOffering Copy an Offering
createAcceptedInsurancePlan Create Accepted Insurance Plans
createAddendum Create a new addendum for the selected charting note
createAllergySensitivity Create AllergySensitivity
createAnnouncement Create Announcement
createApiKey create API Key. This capability needs to be turned on for your account first
createAppleHealth Create AppleHealth
createAppointment create appointment mutation for providers. Clients use the completeCheckout mutation
createAppointmentFormAnswerGroupConnection Create a connection between a form answer group and an appointment.
createAppointmentRequest Create a new appointment request as a part of the booking flow
createAppointmentSetting create an Appointment Setting
createAppointmentType create Appointment Type
createAppointmentTypeCptCode Create an Appointment Type CPT Code Object
createAutoTaskGenerator Create auto task generator
createAutomatedInsuranceBillingSetting create automated insurance billing setting
createAvailability Create availability
createBillingItem create billing item
createBrand create Brand
createCarePlan Create and return a care plan
createChangeHealthPatient creates ChangeHealth patient record
createChatSetting create an Chat Setting
createClient Create a Client
createClientRestrictionAuthorization Create client restriction authorization
createClientViaForm deprecated create a client account via a form (e.g a lead capture form) or match to an existing client by name and email. This endpoint is meant to be called unauthenticated. If you want the client to buy or book something at the same time, use the CompleteCheckout mutation.
createCms1500 create CMS1500
createCognitiveStatus Create a CognitiveStatus Object
createComment create Comment
createCompletedCourseItem create CompletedCourseItem
createCompletedOnboardingItem create CompletedOnboardingItem
createContact Creates a Contact
createConversation create Conversation
createCourse create Course
createCourseBenefit create CourseBenefit
createCourseItem create CourseItem
createCustomEmail create custom email
createCustomFood Create a Custom Food
createCustomModule create Custom Module
createCustomModuleForm create Custom Module Form
createDocument create Document
createDosespotClinician Create dosespot clinician
createDraft create Draft
createDsiComment Create a DSI comment
createEbook create ebook
createEntry creates a new Entry
createEpisodeOfCare Create an Episode of Care
createExternalCalendar Create an External Calendar
createFamilyHistory Create Family History
createFaxAcctInfo create Fax Acct Info
createFaxLineRequest Create and return a fax line request
createFeatureToggle Create a FeatureToggle and Return FeatureToggle
createFitbit Create Fitbit
createFolder create Folder
createFormAnswerGroup create FormAnswerGroup
createFullscriptPractitioner Create a Fullscript practitioner account using the Fullscript API
createFunctionalStatus Create a FunctionalStatus Object
createGoal create Goal
createGoalHistory create Goal History
createGoogleFit Create GoogleFit
createGroup Create a Group
createHealthConcern Create a HealthConcern Object
createImmunization Create an Immunization
createImplantableDeviceUser Create Implantable Device User association
createImportDataRequest Create an import data request
createInsuranceAuthorization create an insurance authorization
createInsurancePlan Create Insurance Plan
createLabOrder Create Lab Order
createLocation create Location
createMeal Create a Meal
createMedication Create Medication
createMessageBlast create Message Blast
createNote create Note
createNotificationContact create a Notification Contact
createOffering create offering
createOfferingCoupon Create an Offering Coupon
createOfficeallySftpAccount create OfficeallySftpAccount
createOnboardingFlow create OnboardingFlow
createOnboardingItem create OnboardingItem
createOrAddToWaterIntakeEntry creates a new entry or add to existing water intake entry for the day
createOrganization create Organization
createOrganizationCptCode Create an Organization CPT Code Object
createOrganizationMembership create OrganizationMembership
createPartner Creates a Partner
createPaymentIntent Create a Stripe Payment Intent. Currently used for supporting additional payment methods via a custom front-end. When the payment succeeds, Healthie will receive a webhook and automatically complete the checkout.
createPdfLetterheadTemplate Create `PdfLetterheadTemplate`
createPermissionTemplate create Permission Template
createPersonalizationQuestionnaire create Personalization Questionnaire
createPreferredMedicalCode Create favorite CPT/ICD code
createProcedure Create a Procedure Object
createProduct Create a product
createProviderAcceptedInsurancePlans Create one or more accepted insurance plan associations for a specific provider.
createProviderCptCodes Create ProviderCPTCode Objects
createRecommendation Create a care plan recommendation
createReferral Create new Referring Physician
createReferringPhysician Create new Referring Physician
createRequestedFormCompletion create requested form
createRequestedPayment create requested payment
createRupaOrder Create a Rupa order
createSavedFilter Create a new saved filter
createSentDirectMessage Create a sent direct message
createSentFax create Sent Fax
createSetupIntent Create a Stripe Setup Intent. Used for setting up payment methods for future usage without immediately charging.
createSmartPhrase Create a Smart Phrase
createSmokingStatus Create a Smoking Status
createStripeCustomerDetail Creates a new payment card
createSubscription create Subscription
createSuperBill create super bill
createTag Create a custom user tag
createTask Create a task for provider
createUniqueDeviceIdentifier Create a UniqueDeviceIdentifier Object
createVisitor Creates a Visitor
createWebhook Create Webhook
createWriteOff Create a Write-off
deleteAcceptedInsurancePlan Destroy Accepted Insurance Plan
deleteAllergySensitivity Destroy AllergySensitivity
deleteAnnouncement Destroy Announcement
deleteApiKey Destroy API Key
deleteAppleHealth Destroy AppleHealth
deleteAppointment Delete an Appointment
deleteAppointmentFormAnswerGroupConnection Remove a form_answer_groups connection to an appointment
deleteAppointmentRequest Delete an existing appointment request
deleteAppointmentType Destroy an AppointmentType
deleteAppointmentTypeCptCode Delete a AppointmentTypeCptCode Object
deleteAutoTaskGenerator Delete auto task generator
deleteAvailability delete Availability
deleteBillingItem Destroy a Billing Item
deleteCarePlan Destroy a Care Plan
deleteCarePlanConnection Remove connection for related item(document/goal/recommendation)
deleteClientRestrictionAuthorization Delete client restriction authorization
deleteCms1500 Destroy a Cms1500
deleteCognitiveStatus Delete a CognitivesStatus Object
deleteComment Destroy a Comment
deleteConversationMembership Destroy a Conversation Membership
deleteCourse Destroy a Course
deleteCourseBenefit Destroy a Course Benefit
deleteCourseGroup Destroy a Course Group
deleteCourseItem Destroy a Course Item
deleteCourseMembership Destroy a Course Membership
deleteCustomEmail Destroy a Custom Email
deleteCustomFood Destroy a Custom Food
deleteCustomModule Destroy an CustomModule
deleteCustomModuleForm Destroy an CustomModuleForm
deleteDexcomConnection Destroy Dexcom Connection
deleteDocument Destroy a Document
deleteEntry Destroy a Entry
deleteEpisodeOfCare Delete an Episode of Care
deleteExternalCalendar Destroy an External Calendar
deleteFamilyHistory Delete a Family History Condition
deleteFaxAcctInfo destroy Fax Acct Info
deleteFitbit Destroy Fitbit
deleteFolder Destroy a Folder
deleteFormAnswerGroup Destroy a Form Answer Group
deleteFormAnswerGroupSigning Destroy FormAnswerGroupSigning
deleteFunctionalStatus Delete a FunctionalStatus Object
deleteGoal Destroy a Goal
deleteGoalHistory Destroy a Goal GoalHistory
deleteGoogleFit Destroy GoogleFit
deleteHealthConcern Delete a HealthConcern Object
deleteImplantableDeviceUser Delete an Implantable Device User association
deleteInsuranceAuthorization delete an insurance authorization
deleteInsurancePlan Delete Insurance Plan
deleteLocation Destroy a Location
deleteMeal Destroy a Meal
deleteMedication Destroy Medication
deleteNote Destroy a Note
deleteNotificationContact delete a Notification Contact
deleteOffering Destroy an Offering
deleteOfferingCoupon Destroy an Offering Coupon
deleteOnboardingFlow Destroy a OnboardingFlow
deleteOnboardingItem Destroy a OnboardingItem
deleteOrganizationCptCode Delete a OrganizationCptCode Object
deleteOrganizationInfo Destroy an organization info
deletePermissionTemplate delete Permission Template
deletePreferredMedicalCode Delete favorite CPT/ICD code
deleteProcedure Delete a Procedure Object
deleteProduct Delete a product
deleteProviderAcceptedInsurancePlan Delete an existing provider accepted insurance plan
deleteProviderCptCode Delete a ProviderCptCode Object
deleteReceivedFax Destroy a received fax
deleteRecommendation Destroy a care plan recommendation
deleteRecurringForm Delete recurring form request
deleteReferral Delete referral
deleteReferringPhysician Delete referring physician
deleteRequestedFormCompletion Destroy a requested form
deleteRequestedPayment destroy requested payment
deleteSavedFilter Delete a saved filter
deleteShapaConnection Destroy Shapa Connection
deleteSmartPhrase Destroy a Smart Phrase
deleteSmokingStatus Delete a Smoking Status
deleteStripeCustomerDetail Deletes a payment card
deleteSuperBill Destroy a Super Bill
deleteTag Delete a custom user tag
deleteTask Destroy a task
deleteUniqueDeviceIdentifier Delete a UniqueDeviceIdentifier Object
deleteUserGroup Delete a Group
deleteWebhook Destroy Webhook
deleteWithingsConnection Destroy Withings Connection
deleteWriteOff Delete a write-off
destroyPdfLetterheadTemplate Delete `PdfLetterheadTemplate`
dismissAllAnnouncements Dismiss All Announcements For A User
dismissAnnouncement Dismiss Announcement
editAvailability edit Availability
expireWebhookSignature Expires the webhook signature
exportCarePlanToTemplate Creates a template from existing Care Plan. Original object is not touched
exportClientEhi Export Client EHI data
generateChartingPdf Generate a PDF of charting notes for a client
healthAssessmentServiceSignup Sign up Healthie User in the Health Assessment Service
ingestMedicationsFromSurescripts ingest med history from surescripts
linkEncounterToEpisodeOfCare Link patient encounter(s) to an Episode of Care
lockFormAnswerGroup Lock `FormAnswerGroup`
logMedicationHistoryConsent Log that a patient has consented to having their medication history pulled via Surescripts/Dosespot
mergeClients all data related to the merging account (form answers, billing items, charting notes, etc) will be associated with the selected account after merging. The selected account's client profile information will remain unchanged (name, DOB, etc)
parseCcdaDocument Import client from a CCDA file
refetchChangeHealthLabOrder refetch ChangeHealth Lab Orders for a specified patient
rejectGeneratedFormAnswerGroup Rejects an AI-generated form answer group
removeAppliedTag Remove applied tag on a specific user
removeDraft remove Draft
removeUserFromGroupCarePlan Remove group care plan user connection for a specific user
resendSentFax resend Sent Fax
resetDefaultPdfLetterheadTemplate Set system default `PdfLetterheadTemplate` for current_user's organization
resetPassword send the human a password reset email
resyncRupaLabOrders Resync existed rupa lab orders data for a specific rupa connection of the current user
revokeToken revoke token or API key.
runEligibilityCheck Run an eligibility check on a policy
sendCarePlanEmail Trigger care plan email for given client
sendSpeakToTrainerNotification Send the trainer an email that the client wants to speak to them
sendTestWebhook Sends a test webhook to the specified URL
setDefaultPdfLetterheadTemplate Set `PdfLetterheadTemplate` default for the org
shareAnswersAsDocument Add form answer group answers as document viewable by client
shareCourse share Course with another provider
shareCustomModuleForm share Custom Module Form
signFormAnswerGroup Sign `FormAnswerGroup`
signIn SignIn
signUp Sign up
toggleCarePlanStatusForSpecificUser Deactivate/activate a group/single Care Plan for a given user
unlinkEncounterToEpisodeOfCare Unlink patient encounter(s) from an Episode of Care
unlockFormAnswerGroup Unlock `FormAnswerGroup`
unsubscribeFromNotification Update a Notification Setting to unsubscribe from a specific notification type
updateAllergySensitivity Update AllergySensitivity
updateAnnouncement Update Announcement
updateAppleHealth Update AppleHealth
updateAppointment Update the Appointment
updateAppointmentInclusion Update AppointmentInclusion
updateAppointmentRequest Update an existing appointment request
updateAppointmentSetting update Appointment Setting
updateAppointmentType Update an Appointment Type and return Appointment Type
updateAppointmentTypeCptCode Update a AppointmentTypeCptCode Object
updateAutoTaskGenerator Update auto task generator
updateAutomatedInsuranceBillingSetting update automated insurance billing setting
updateBillingItem Update a BillingItem
updateBrand Update a Brand and return Brand
updateByTemplate Update Care Plan by Care Plan Template
updateCalendarViewSetting Update and return calendar view setting
updateCalorieLevel Update Calorie Levels in the Health Assessment Service
updateCarePlan Update and return a Care Plan
updateChangeHealthAccount Update ChangeHealthAccount (used for Labs)
updateChargeBack Update ChargeBack
updateChatSetting update Chat Setting
updateClient Update Client
updateCms1500 update CMS1500
updateCognitiveStatus Update a CognitiveStatus Object
updateConversation Update a Conversation and return Conversation
updateConversationMembership Update a ConversationMembership and return ConversationMembership
updateCourse Update a Course
updateCourseGroup update a Course Group
updateCourseItem Update a CourseItem
updateCourseMembership update a Course Membership
updateCustomEmail Update a Custom Email
updateCustomFood Update a Custom Food
updateCustomModule Update an Custom Module and return Custom Module
updateCustomModuleForm Update an Custom Module Form and return Custom Module Form
updateDocument Update a Document and return Document
updateDsiComment Update a DSI comment
updateEntry Updates an Entry and returns an Entry
updateEpisodeOfCare Update an Episode of Care
updateExternalCalendar Update an External Calendar
updateFamilyHistory Update Family History
updateFaxAcctInfo update Fax Acct Info
updateFeatureToggle Update a FeatureToggle and Return FeatureToggle
updateFitbit Update Fitbit
updateFolder Update a Folder and return Folder
updateFormAnswerGroup update FormAnswerGroup
updateFunctionalStatus Update a FunctionalStatus Object
updateGeneratedFormAnswerGroupFeedback Updates feedback for an AI-generated form answer group
updateGoal Update a Goal
updateGoogleFit Update GoogleFit
updateGroupCarePlan Updates the care plan status for groups
updateHealthConcern Update a HealthConcern Object
updateHuman Update a Human
updateImmunization Update an Immunization and return Immunization
updateImplantableDeviceUser Update Implantable Device User association
updateInsuranceAuthorization update an insurance authorization
updateInsurancePlan Update Insurance Plan
updateLabOrder Update Lab Order
updateLocation update Location
updateMacronutrientSplit Update Macronutrient Split in the Health Assessment Service
updateMeal Update a Meal
updateMedication Update Medication
updateNote Update a Note
updateNoteScheduler Update a Note Scheduler and return NoteSchedulerType
updateNotification update a notification
updateNotificationContact Update a Notification Contact
updateNotificationRecords Update multiple notification records at once
updateNotificationSetting Update a Notification Setting and return Notification Setting
updateNotifications update multiple notifications at once
updateOffering Update an Offering
updateOfficeallySftpAccount update OfficeallySftpAccount
updateOnboardingFlow Update a OnboardingFlow and return OnboardingFlow
updateOnboardingItem Update a OnboardingItem and return OnboardingItem
updateOrganization Update Organization
updateOrganizationCptCode Update a OrganizationCptCode Object
updateOrganizationMember Update org members
updateOrganizationMembership Update a OrganizationMembership
updatePdfLetterheadTemplate Update `PdfLetterheadTemplate`
updatePermissionTemplate update Permission Template
updatePolicy Update a policy
updateProcedure Update a Procedure Object
updateProduct Update a product
updateProviderCptCodes Update ProviderCptCode Objects
updateReceivedDirectMessage Update a Received Direct Message
updateReceivedFax update a received fax
updateRecommendation Update a care plan recommendation
updateRecurringForm update a recurring form
updateReferral Update Referral
updateReferringPhysician Update Referring Physician
updateRequestedPayment update requested payment
updateSavedFilter Update an existing saved filter
updateSmartPhrase Update a Smart Phrase
updateSmokingStatus Update a Smoking Status
updateState Archive/Unarchive a Course
updateStripeCustomerDetail Updates a payment card
updateStripeVerificationDetails Update Stripe Verification Details
updateSubscription update Subscription
updateSuperBill Update a SuperBill
updateTag Update a custom user tag
updateTask Update a task for provider
updateTasksBulk Update multiple tasks provider
updateUniqueDeviceIdentifier Update a UniqueDeviceIdentifier Object
updateUser Update the current user, or a patient that the current user has access to. To update other org members, use updateOrganizationMembership
updateUserAppointmentPricing Updates the appointment pricing for this user
updateUserGroup Update a Group
updateWebhook Update Webhook
updateWriteOff Update a Write-off
uploadBatchToCandidHealth Upload a CMS1500 batch to CandidHealth
uploadBatchToChangeHealth Upload a CMS1500 batch to ChangeHealth
uploadBatchToOfficeally Upload a CMS1500 batch to OfficeAlly
uploadCms1500sToIntegrations Upload a CMS1500 to integrations: ChangeHealth, OfficeAlly, CandidHealth
validateVerificationToken Verify 2FA code for Human