Nectar API Reference
Introduction
In order to be familiar with the Nectar graphql API, you could play around with the sandbox to see how the data are being accessed.
- URL: https://dev-clinic.app.staging.nectar.vet/
- Interactive graphql endpoint: https://dev-clinic.api.staging.nectar.vet/graphql
Look for endpoints you need
Since our api is powered by our own graphql server, your implementation will be able to leverage all our features. That being said, we want to make sure you are only requesting data that you need. Please record the endpoints you need in a document and share it with us. We will nudge you to use endpoints that have pagination built in. We will also make sure you are not requesting sensitive data such as finance or api key data.
Go live
Schedule a meeting with Harris @ https://calendly.com/harris-tsim/30min?back=1 to go over your list of endpoints needed from the api. We will whitelist the endpoints you need and you will be call them.
Terms of Service
API Endpoints
# Request Token Endpoint (default):
https://nectarstaging.us.auth0.com/oauth/token
# Production:
https://nectarvet.us.auth0.com/oauth/token
Headers
# The token you received from https://nectarstaging.us.auth0.com/oauth/token
Authorization: Bearer <YOUR_TOKEN_HERE>Using Curl to get invoices data
Step1: Get access token
curl --request POST \
--url https://nectarstaging.us.auth0.com/oauth/token \
--header 'Content-Type: application/json' \
--data '{
"client_id": "[YOUR_CLIENT_ID]",
"client_secret": "[YOUR_CLIENT_SECRET]",
"audience": "https://login.nectarvet.com",
"grant_type": "client_credentials"
}'
Step2: Call GraphQL endpoint to retrieve data
curl -X POST https://dev-clinic.api.staging.nectar.vet/graphql \
-H "Authorization: Bearer <Access token from step1>" \
-H "Content-Type: application/json" \
-H "X-Auth-Type: server" \
-d '{
"query": "query InvoicesPaginated($filter: InvoiceViewFilterSchema, $sort: [Sorter!], $paginationInfo: PaginationInfo) { invoicesPaginated(filter: $filter, sort: $sort, paginationInfo: $paginationInfo) { edges { cursor node { id items { cost name } paymentStatus client { firstName lastName emailH emailW } patient { patientId status firstName lastName species breed } } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor count } } }",
"variables": {
"filter": {
"status": { "value1": "DELETED", "operator": "NE" },
"createdAt": { "value1": "2024-10-01T00:00:00.000-07:00", "value2": "2024-10-31T23:59:59.999-07:00", "operator": "BET" }
},
"sort": [ { "field": "created_at", "order": "DESCENDING" } ],
"paginationInfo": { "cursor": "", "perPage": 15, "mode": "FORWARD" }
}
}'
Queries
accountsReceivableAccount
Response
Returns an AccountsReceivableSchema!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query AccountsReceivableAccount($clientId: ID!) {
accountsReceivableAccount(clientId: $clientId) {
id
clientId
firstName
lastName
status
email
phone
current
thirtyDays
sixtyDays
ninetyDays
totalDue
lastPaymentDate
lastStatementDate
lastReminderSentAt
deletedAt
createdAt
updatedAt
}
}
Variables
{"clientId": "4"}
Response
{
"data": {
"accountsReceivableAccount": {
"id": 4,
"clientId": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"status": "ACTIVE",
"email": "abc123",
"phone": "xyz789",
"current": 123,
"thirtyDays": 987,
"sixtyDays": 123,
"ninetyDays": 987,
"totalDue": 123,
"lastPaymentDate": datetime,
"lastStatementDate": datetime,
"lastReminderSentAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
accountsReceivableTotals
Response
Returns an AccountsReceivableTotalsSchema!
Example
Query
query AccountsReceivableTotals {
accountsReceivableTotals {
totalCurrent
totalThirtyDays
totalSixtyDays
totalNinetyDays
totalDue
lastSyncedAt
}
}
Response
{
"data": {
"accountsReceivableTotals": {
"totalCurrent": 123,
"totalThirtyDays": 123,
"totalSixtyDays": 123,
"totalNinetyDays": 987,
"totalDue": 987,
"lastSyncedAt": datetime
}
}
}
accountsReceivablesPaginated
Response
Returns an AccountsReceivableSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AccountsReceivableViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AccountsReceivablesPaginated(
$filter: AccountsReceivableViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
accountsReceivablesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...AccountsReceivableSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"accountsReceivablesPaginated": {
"pageInfo": PageInfo,
"edges": [AccountsReceivableSchemaEdge]
}
}
}
activeAppointment
Response
Returns an AppointmentSchema
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query ActiveAppointment($patientId: ID!) {
activeAppointment(patientId: $patientId) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{"patientId": 4}
Response
{
"data": {
"activeAppointment": {
"appointmentId": "4",
"assignedUid": "4",
"creatorUid": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": 4,
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "xyz789",
"reminderNotifSent": false,
"confirmNotifSent": false,
"isRecurring": true,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": true,
"followUpNotes": "xyz789",
"alternativeTimes": "xyz789",
"onlineRequestExpireAt": datetime,
"cancellationReason": "xyz789",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": false,
"isSmsable": true,
"convertToLocal": false
}
}
}
activeAppointmentCheckout
Response
Returns an AppointmentCheckoutSchema
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query ActiveAppointmentCheckout($patientId: ID!) {
activeAppointmentCheckout(patientId: $patientId) {
id
appointmentId
soapId
surgeryId
deletedAt
todos {
... on EmailOrPrintTodoSchema {
...EmailOrPrintTodoSchemaFragment
}
... on RxScriptTodoSchema {
...RxScriptTodoSchemaFragment
}
... on VaccineCertificateTodoSchema {
...VaccineCertificateTodoSchemaFragment
}
... on LabTodoSchema {
...LabTodoSchemaFragment
}
... on ScheduleFollowUpTodoSchema {
...ScheduleFollowUpTodoSchemaFragment
}
... on PaymentTodoSchema {
...PaymentTodoSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"activeAppointmentCheckout": {
"id": 4,
"appointmentId": "4",
"soapId": "4",
"surgeryId": 4,
"deletedAt": datetime,
"todos": [EmailOrPrintTodoSchema],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
activeAppointments
Response
Returns [AppointmentViewSchema!]
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query ActiveAppointments($patientId: ID!) {
activeAppointments(patientId: $patientId) {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentTypeId
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
}
Variables
{"patientId": 4}
Response
{
"data": {
"activeAppointments": [
{
"id": "4",
"appointmentId": "4",
"creatorUid": "4",
"assignedUid": "4",
"patientId": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"status": "xyz789",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": false,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": false,
"confirmNotifSent": false,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"assignedEmployee": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"appointmentTypeId": 4,
"appointmentType": AppointmentTypeResolveSchema,
"isOnlineRequest": true,
"followUpNotes": "xyz789",
"alternativeTimes": "xyz789",
"onlineRequestExpireAt": datetime,
"cancellationReason": "xyz789",
"isRecurring": true
}
]
}
}
addendum
Response
Returns an AddendumSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Addendum($id: ID!) {
addendum(id: $id) {
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"addendum": {
"creator": ClinicUserSchema,
"id": "4",
"refId": "4",
"refType": "SOAP",
"creatorId": 4,
"description": "xyz789",
"timestamp": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addendumsByMedicalNote
Response
Returns [AddendumSchema!]!
Example
Query
query AddendumsByMedicalNote(
$refId: ID!,
$refType: NoteType!
) {
addendumsByMedicalNote(
refId: $refId,
refType: $refType
) {
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
}
Variables
{"refId": "4", "refType": "SOAP"}
Response
{
"data": {
"addendumsByMedicalNote": [
{
"creator": ClinicUserSchema,
"id": 4,
"refId": "4",
"refType": "SOAP",
"creatorId": "4",
"description": "xyz789",
"timestamp": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
addendumsPaginated
Response
Returns an AddendumViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AddendumViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AddendumsPaginated(
$filter: AddendumViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
addendumsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...AddendumViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"addendumsPaginated": {
"pageInfo": PageInfo,
"edges": [AddendumViewSchemaEdge]
}
}
}
appointment
Response
Returns an AppointmentSchema!
Arguments
| Name | Description |
|---|---|
appointmentId - ID!
|
Example
Query
query Appointment($appointmentId: ID!) {
appointment(appointmentId: $appointmentId) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{"appointmentId": 4}
Response
{
"data": {
"appointment": {
"appointmentId": "4",
"assignedUid": 4,
"creatorUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"assignedEmployee": ClinicUserSchema,
"patientId": "4",
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "xyz789",
"reminderNotifSent": false,
"confirmNotifSent": true,
"isRecurring": true,
"smsReminderNotifId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": false,
"followUpNotes": "xyz789",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": true,
"convertToLocal": false
}
}
}
appointmentCheckout
Response
Returns an AppointmentCheckoutSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query AppointmentCheckout($id: ID!) {
appointmentCheckout(id: $id) {
id
appointmentId
soapId
surgeryId
deletedAt
todos {
... on EmailOrPrintTodoSchema {
...EmailOrPrintTodoSchemaFragment
}
... on RxScriptTodoSchema {
...RxScriptTodoSchemaFragment
}
... on VaccineCertificateTodoSchema {
...VaccineCertificateTodoSchemaFragment
}
... on LabTodoSchema {
...LabTodoSchemaFragment
}
... on ScheduleFollowUpTodoSchema {
...ScheduleFollowUpTodoSchemaFragment
}
... on PaymentTodoSchema {
...PaymentTodoSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"appointmentCheckout": {
"id": "4",
"appointmentId": "4",
"soapId": 4,
"surgeryId": 4,
"deletedAt": datetime,
"todos": [EmailOrPrintTodoSchema],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
appointmentCheckoutsPaginated
Response
Returns an AppointmentCheckoutViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AppointmentCheckoutViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AppointmentCheckoutsPaginated(
$filter: AppointmentCheckoutViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
appointmentCheckoutsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...AppointmentCheckoutViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"appointmentCheckoutsPaginated": {
"pageInfo": PageInfo,
"edges": [AppointmentCheckoutViewSchemaEdge]
}
}
}
appointmentType
Response
Returns an AppointmentTypeSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query AppointmentType($id: ID!) {
appointmentType(id: $id) {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"appointmentType": {
"id": 4,
"creatorId": "4",
"legacyKey": "abc123",
"name": "abc123",
"category": "MEDICAL",
"description": "xyz789",
"color": "abc123",
"defaultMinutes": 123,
"depositRequired": true,
"depositAmount": 123,
"order": 123,
"directOnlineEnabled": true,
"isRequired": false,
"sendReminderNotifications": false,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
appointmentTypes
Response
Returns [AppointmentTypeSchema!]!
Example
Query
query AppointmentTypes {
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"appointmentTypes": [
{
"id": 4,
"creatorId": 4,
"legacyKey": "abc123",
"name": "xyz789",
"category": "MEDICAL",
"description": "abc123",
"color": "xyz789",
"defaultMinutes": 123,
"depositRequired": true,
"depositAmount": 987,
"order": 987,
"directOnlineEnabled": false,
"isRequired": false,
"sendReminderNotifications": false,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
appointmentTypesPaginated
Response
Returns an AppointmentTypeViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AppointmentTypeViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AppointmentTypesPaginated(
$filter: AppointmentTypeViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
appointmentTypesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...AppointmentTypeViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"appointmentTypesPaginated": {
"pageInfo": PageInfo,
"edges": [AppointmentTypeViewSchemaEdge]
}
}
}
appointments
Response
Returns [AppointmentSchema!]!
Example
Query
query Appointments(
$patientId: ID,
$startDatetime: datetime,
$endDatetime: datetime,
$showCanceled: Boolean,
$showTempExpired: Boolean,
$limit: Int
) {
appointments(
patientId: $patientId,
startDatetime: $startDatetime,
endDatetime: $endDatetime,
showCanceled: $showCanceled,
showTempExpired: $showTempExpired,
limit: $limit
) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{
"patientId": null,
"startDatetime": null,
"endDatetime": null,
"showCanceled": null,
"showTempExpired": false,
"limit": null
}
Response
{
"data": {
"appointments": [
{
"appointmentId": 4,
"assignedUid": "4",
"creatorUid": "4",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": 4,
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": "4",
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": true,
"isRecurring": false,
"smsReminderNotifId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": false,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": true,
"convertToLocal": true
}
]
}
}
appointmentsForReport
Response
Returns [AppointmentSchema!]!
Example
Query
query AppointmentsForReport(
$startDatetime: datetime!,
$endDatetime: datetime!
) {
appointmentsForReport(
startDatetime: $startDatetime,
endDatetime: $endDatetime
) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{
"startDatetime": datetime,
"endDatetime": datetime
}
Response
{
"data": {
"appointmentsForReport": [
{
"appointmentId": 4,
"assignedUid": "4",
"creatorUid": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": 4,
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": false,
"isRecurring": false,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": true,
"followUpNotes": "xyz789",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "xyz789",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": true,
"convertToLocal": true
}
]
}
}
appointmentsPaginated
Response
Returns an AppointmentViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AppointmentViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AppointmentsPaginated(
$filter: AppointmentViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
appointmentsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...AppointmentViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"appointmentsPaginated": {
"pageInfo": PageInfo,
"edges": [AppointmentViewSchemaEdge]
}
}
}
approvedUnlinkedEstimates
Response
Returns [EstimateSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
|
media - MediaQueryInputSchema
|
Default = null |
Example
Query
query ApprovedUnlinkedEstimates(
$patientId: ID!,
$media: MediaQueryInputSchema
) {
approvedUnlinkedEstimates(
patientId: $patientId,
media: $media
) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"patientId": 4, "media": null}
Response
{
"data": {
"approvedUnlinkedEstimates": [
{
"soap": SoapSchema,
"estimateId": "4",
"status": "OPEN",
"patientId": 4,
"creatorUid": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": 4,
"items": [EstimateItemSchema],
"isRange": true,
"minSubtotal": 987,
"maxSubtotal": 123,
"isTaxExempt": false,
"minTax": 987,
"maxTax": 123,
"minPstTax": 123,
"maxPstTax": 123,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 987,
"discount": 123,
"minTotal": 123,
"maxTotal": 123,
"approved": false,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": "4",
"otherApproverName": "xyz789",
"media": [MediaSchema],
"title": "xyz789",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
assignedConversations
Response
Returns a ConversationSchemaConnection!
Arguments
| Name | Description |
|---|---|
employeeId - ID!
|
|
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AssignedConversations(
$employeeId: ID!,
$paginationInfo: PaginationInfo
) {
assignedConversations(
employeeId: $employeeId,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...ConversationSchemaFragment
}
cursor
}
}
}
Variables
{"employeeId": 4, "paginationInfo": null}
Response
{
"data": {
"assignedConversations": {
"pageInfo": PageInfo,
"edges": [ConversationSchemaEdge]
}
}
}
audioAssetsPaginated
Response
Returns a MediaSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AudioMediaFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AudioAssetsPaginated(
$filter: AudioMediaFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
audioAssetsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...MediaSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"audioAssetsPaginated": {
"pageInfo": PageInfo,
"edges": [MediaSchemaEdge]
}
}
}
auditsPaginated
Response
Returns an AuditSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - AuditFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query AuditsPaginated(
$filter: AuditFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
auditsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...AuditSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"auditsPaginated": {
"pageInfo": PageInfo,
"edges": [AuditSchemaEdge]
}
}
}
boardingReservation
Response
Returns a BoardingReservationViewSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query BoardingReservation($id: ID!) {
boardingReservation(id: $id) {
id
kennelId
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
kennel {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
startDatetime
endDatetime
notes
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"boardingReservation": {
"id": "xyz789",
"kennelId": 4,
"creator": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"kennel": KennelSchema,
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
boardingReservationsByDates
Response
Example
Query
query BoardingReservationsByDates(
$startDate: datetime!,
$endDate: datetime!,
$weeksBuffer: Int!
) {
boardingReservationsByDates(
startDate: $startDate,
endDate: $endDate,
weeksBuffer: $weeksBuffer
) {
id
kennelId
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
kennel {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
startDatetime
endDatetime
notes
status
deletedAt
createdAt
updatedAt
}
}
Variables
{
"startDate": datetime,
"endDate": datetime,
"weeksBuffer": 4
}
Response
{
"data": {
"boardingReservationsByDates": [
{
"id": "xyz789",
"kennelId": "4",
"creator": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"kennel": KennelSchema,
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
boardingReservationsPaginated
Response
Returns a BoardingReservationViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - BoardingReservationViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query BoardingReservationsPaginated(
$filter: BoardingReservationViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
boardingReservationsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...BoardingReservationViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"boardingReservationsPaginated": {
"pageInfo": PageInfo,
"edges": [BoardingReservationViewSchemaEdge]
}
}
}
breed
Response
Returns a BreedSchema!
Arguments
| Name | Description |
|---|---|
breedId - ID!
|
Example
Query
query Breed($breedId: ID!) {
breed(breedId: $breedId) {
breedId
name
species
imageData
}
}
Variables
{"breedId": "4"}
Response
{
"data": {
"breed": {
"breedId": 4,
"name": "xyz789",
"species": "abc123",
"imageData": "abc123"
}
}
}
breedByName
Response
Returns a BreedSchema!
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query BreedByName($name: String!) {
breedByName(name: $name) {
breedId
name
species
imageData
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"breedByName": {
"breedId": 4,
"name": "abc123",
"species": "abc123",
"imageData": "abc123"
}
}
}
breeds
Response
Returns [BreedSchema!]!
Arguments
| Name | Description |
|---|---|
species - String
|
Default = null |
Example
Query
query Breeds($species: String) {
breeds(species: $species) {
breedId
name
species
imageData
}
}
Variables
{"species": null}
Response
{
"data": {
"breeds": [
{
"breedId": 4,
"name": "xyz789",
"species": "xyz789",
"imageData": "abc123"
}
]
}
}
bundle
Response
Returns a BundleSchema!
Arguments
| Name | Description |
|---|---|
bundleId - ID!
|
Example
Query
query Bundle($bundleId: ID!) {
bundle(bundleId: $bundleId) {
bundleId
name
treatments {
name
treatmentId
pricePerUnit
minimumQty
maximumQty
order
hideItem
}
createdAt
updatedAt
useQtyRange
hideAllItemsPrices
}
}
Variables
{"bundleId": 4}
Response
{
"data": {
"bundle": {
"bundleId": "4",
"name": "abc123",
"treatments": [BundleTreatmentSchema],
"createdAt": datetime,
"updatedAt": datetime,
"useQtyRange": true,
"hideAllItemsPrices": false
}
}
}
bundles
Response
Returns [BundleSchema!]!
Example
Query
query Bundles {
bundles {
bundleId
name
treatments {
name
treatmentId
pricePerUnit
minimumQty
maximumQty
order
hideItem
}
createdAt
updatedAt
useQtyRange
hideAllItemsPrices
}
}
Response
{
"data": {
"bundles": [
{
"bundleId": "4",
"name": "abc123",
"treatments": [BundleTreatmentSchema],
"createdAt": datetime,
"updatedAt": datetime,
"useQtyRange": false,
"hideAllItemsPrices": false
}
]
}
}
calls
Response
Returns [CallSchema!]!
Example
Query
query Calls {
calls {
id
sourceNumber
sourceClient {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
destinationClient {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
analytics {
summary
sentiment
transcript
}
callUrl
mangoWebhookRequestId
isRecorded
callDirection
callStatus
callTime
callUuid
destinationNumber
dstExt
mangoSourceNumber
srcExt
callflow
conferenceId
duration
}
}
Response
{
"data": {
"calls": [
{
"id": 4,
"sourceNumber": "xyz789",
"sourceClient": ClinicUserSchema,
"destinationClient": ClinicUserSchema,
"analytics": CallSummaryAnalyticsSchema,
"callUrl": "xyz789",
"mangoWebhookRequestId": "4",
"isRecorded": "xyz789",
"callDirection": "INTERNAL",
"callStatus": "ANSWERED",
"callTime": datetime,
"callUuid": "xyz789",
"destinationNumber": "xyz789",
"dstExt": "xyz789",
"mangoSourceNumber": "xyz789",
"srcExt": "abc123",
"callflow": "abc123",
"conferenceId": "abc123",
"duration": 123
}
]
}
}
canDeleteKennel
Response
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query CanDeleteKennel($id: ID!) {
canDeleteKennel(id: $id) {
id
kennelId
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
kennel {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
startDatetime
endDatetime
notes
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"canDeleteKennel": [
{
"id": "abc123",
"kennelId": "4",
"creator": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"kennel": KennelSchema,
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "abc123",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
cashReconciliationPaginated
Response
Returns a TransactionViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query CashReconciliationPaginated($paginationInfo: PaginationInfo) {
cashReconciliationPaginated(paginationInfo: $paginationInfo) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...TransactionViewSchemaFragment
}
cursor
}
}
}
Variables
{"paginationInfo": null}
Response
{
"data": {
"cashReconciliationPaginated": {
"pageInfo": PageInfo,
"edges": [TransactionViewSchemaEdge]
}
}
}
chatSessionMessages
Response
Returns [ChatSessionMessageSchema!]!
Example
Query
query ChatSessionMessages(
$chatSessionId: String!,
$patientId: ID!
) {
chatSessionMessages(
chatSessionId: $chatSessionId,
patientId: $patientId
) {
message
type
createdAt
}
}
Variables
{
"chatSessionId": "xyz789",
"patientId": "4"
}
Response
{
"data": {
"chatSessionMessages": [
{
"message": "abc123",
"type": "xyz789",
"createdAt": datetime
}
]
}
}
client
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Client($id: ID!) {
client(id: $id) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"id": "4"}
Response
{
"data": {
"client": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "abc123",
"lastName": "xyz789",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "abc123",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
clientPatients
Response
Returns [PatientViewSchema!]!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query ClientPatients($clientId: ID!) {
clientPatients(clientId: $clientId) {
photoUrl
profilePictureMediaId
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
id
patientId
extId
familyId
contactUid
firstName
firstNameLowercase
status
species
lastName
breed
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
dateOfBirth
dateOfDeath
weightLbs
weightKg
color
gender
spayNeuter
warnings
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
microchip
createdAt
updatedAt
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"clientId": 4}
Response
{
"data": {
"clientPatients": [
{
"photoUrl": "abc123",
"profilePictureMediaId": 4,
"contact": ClinicUserSchema,
"createdVia": "APP",
"id": 4,
"patientId": "4",
"extId": "abc123",
"familyId": "4",
"contactUid": "4",
"firstName": "xyz789",
"firstNameLowercase": "xyz789",
"status": "ACTIVE",
"species": "abc123",
"lastName": "abc123",
"breed": "xyz789",
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"weightLbs": 123.45,
"weightKg": 123.45,
"color": "xyz789",
"gender": "MALE",
"spayNeuter": true,
"warnings": "abc123",
"chatSessions": [ChatSessionSchema],
"microchip": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"client": ClinicUserSchema,
"family": FamilySchema,
"profilePicture": MediaSchema,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
clientPatientsAppointments
Response
Returns [AppointmentViewSchema!]!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query ClientPatientsAppointments($clientId: ID!) {
clientPatientsAppointments(clientId: $clientId) {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentTypeId
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
}
Variables
{"clientId": "4"}
Response
{
"data": {
"clientPatientsAppointments": [
{
"id": 4,
"appointmentId": "4",
"creatorUid": 4,
"assignedUid": "4",
"patientId": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": "4",
"status": "xyz789",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"checkinTime": datetime,
"staffNotes": "xyz789",
"reminderNotifSent": false,
"confirmNotifSent": true,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"assignedEmployee": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"appointmentTypeId": "4",
"appointmentType": AppointmentTypeResolveSchema,
"isOnlineRequest": true,
"followUpNotes": "xyz789",
"alternativeTimes": "xyz789",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"isRecurring": true
}
]
}
}
clientPatientsMedicalHistory
Response
Returns [MedicalHistoryViewSchema!]!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query ClientPatientsMedicalHistory($clientId: ID!) {
clientPatientsMedicalHistory(clientId: $clientId) {
origItems {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on LabResultSchema {
...LabResultSchemaFragment
}
... on PrescriptionOrderSchema {
...PrescriptionOrderSchemaFragment
}
... on PrescriptionFillSchema {
...PrescriptionFillSchemaFragment
}
... on MiscNoteSchema {
...MiscNoteSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on MediaSchema {
...MediaSchemaFragment
}
... on FormSubmissionViewSchema {
...FormSubmissionViewSchemaFragment
}
... on XraySchema {
...XraySchemaFragment
}
... on PatientVitalSchema {
...PatientVitalSchemaFragment
}
... on TaskSchema {
...TaskSchemaFragment
}
... on LinkSchema {
...LinkSchemaFragment
}
... on TreatmentPlanViewSchema {
...TreatmentPlanViewSchemaFragment
}
... on EmailLogSchema {
...EmailLogSchemaFragment
}
}
id
patientId
type
origItemIds
deletedAt
createdAt
updatedAt
displayDate
displayString
}
}
Variables
{"clientId": 4}
Response
{
"data": {
"clientPatientsMedicalHistory": [
{
"origItems": [CommunicationSchema],
"id": 4,
"patientId": "4",
"type": "SOAP_NOTE",
"origItemIds": [4],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"displayDate": datetime,
"displayString": "xyz789"
}
]
}
}
clientPatientsPrescriptions
Response
Returns [RxScriptViewSchema!]!
Example
Query
query ClientPatientsPrescriptions(
$clientId: ID!,
$limit: Int
) {
clientPatientsPrescriptions(
clientId: $clientId,
limit: $limit
) {
id
rxScriptId
patientId
clientId
totalDosage
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
beginsAt
expiresAt
refills
duration
voided
treatment
createdAt
updatedAt
instructions
creatorUid
filledById
refId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientFirstNameLowercase
clientLastNameLowercase
originalRefId
renewedRefId
renewedFromRefId
treatmentId
providerLastNameLowercase
originalRxScript {
originalRxScript {
...RxScriptOriginalSchemaFragment
}
mostRecentRefill {
...RxScriptOriginalSchemaFragment
}
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
originalRxScript {
...RxScriptOriginalSchemaFragment
}
mostRecentRefill {
...RxScriptOriginalSchemaFragment
}
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
}
Variables
{"clientId": 4, "limit": 10}
Response
{
"data": {
"clientPatientsPrescriptions": [
{
"id": "4",
"rxScriptId": "4",
"patientId": 4,
"clientId": "4",
"totalDosage": Decimal,
"durationUnit": "abc123",
"customDoseUnit": "abc123",
"isCustomTreatment": true,
"customTreatmentIsRxScript": false,
"beginsAt": datetime,
"expiresAt": datetime,
"refills": 123,
"duration": 987,
"voided": false,
"treatment": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"instructions": "xyz789",
"creatorUid": "4",
"filledById": 4,
"refId": 4,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"patientFirstNameLowercase": "abc123",
"clientLastNameLowercase": "xyz789",
"originalRefId": 4,
"renewedRefId": "4",
"renewedFromRefId": 4,
"treatmentId": "4",
"providerLastNameLowercase": "xyz789",
"originalRxScript": RxScriptSchema,
"mostRecentRefill": RxScriptSchema
}
]
}
}
clientPatientsReminders
Response
Returns [ReminderSchema!]!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query ClientPatientsReminders($clientId: ID!) {
clientPatientsReminders(clientId: $clientId) {
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
vaccine {
media {
...MediaSchemaFragment
}
vaccineId
status
patientId
creatorUid
item {
...VaccineItemSchemaFragment
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
isEmailable
isSmsable
reminderId
status
patientId
refId
notes
type
creatorUid
invoiceId
dueDate
createdAt
updatedAt
}
}
Variables
{"clientId": 4}
Response
{
"data": {
"clientPatientsReminders": [
{
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": true,
"isSmsable": false,
"reminderId": 4,
"status": "ACTIVE",
"patientId": "4",
"refId": 4,
"notes": "abc123",
"type": "TREATMENT",
"creatorUid": "4",
"invoiceId": 4,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
clientPatientsVaccines
Response
Returns [VaccineViewSchema!]!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query ClientPatientsVaccines($clientId: ID!) {
clientPatientsVaccines(clientId: $clientId) {
id
patientId
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
createdAt
updatedAt
status
creatorUid
clientId
treatmentId
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
vaccineId
instanceId
approverId
tagNumber
previousTagNumber
approverName
approverLicense
approved
declined
vaccinationDate
expDate
mediaRef
originalVaccineId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
approver {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
lotNo
serialNo
patientFirstNameLowercase
clientLastNameLowercase
approverLastNameLowercase
}
}
Variables
{"clientId": "4"}
Response
{
"data": {
"clientPatientsVaccines": [
{
"id": 4,
"patientId": "4",
"item": VaccineItemSchema,
"createdAt": datetime,
"updatedAt": datetime,
"status": "OPEN",
"creatorUid": "4",
"clientId": "4",
"treatmentId": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"invoiceId": 4,
"vaccineId": 4,
"instanceId": "4",
"approverId": "4",
"tagNumber": "xyz789",
"previousTagNumber": "xyz789",
"approverName": "abc123",
"approverLicense": "abc123",
"approved": false,
"declined": true,
"vaccinationDate": datetime,
"expDate": datetime,
"mediaRef": "4",
"originalVaccineId": "4",
"patient": PatientSchema,
"media": MediaSchema,
"soap": SoapSchema,
"approver": ClinicUserSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"lotNo": "abc123",
"serialNo": "abc123",
"patientFirstNameLowercase": "xyz789",
"clientLastNameLowercase": "abc123",
"approverLastNameLowercase": "abc123"
}
]
}
}
clientReport
Response
Returns a ClientReportSchema!
Arguments
| Name | Description |
|---|---|
filter - ReportQueryFilter
|
Default = null |
Example
Query
query ClientReport($filter: ReportQueryFilter) {
clientReport(filter: $filter) {
newAndExistingClientTotals {
name
newClientCount
existingClientCount
activeClientCount
lapsingClientCount
lapsedClientCount
}
activeLapsingLapsedClientTotals {
name
newClientCount
existingClientCount
activeClientCount
lapsingClientCount
lapsedClientCount
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"clientReport": {
"newAndExistingClientTotals": [
ClientReportNamedTotalSchema
],
"activeLapsingLapsedClientTotals": [
ClientReportNamedTotalSchema
]
}
}
}
clientSearch
Response
Returns a ClinicUserSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - ClientQueryFilter
|
Default = null |
sort - String
|
Default = "-_id" |
pagination - PaginationFilter
|
Default = null |
Example
Query
query ClientSearch(
$filter: ClientQueryFilter,
$sort: String,
$pagination: PaginationFilter
) {
clientSearch(
filter: $filter,
sort: $sort,
pagination: $pagination
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...ClinicUserSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": "-_id", "pagination": null}
Response
{
"data": {
"clientSearch": {
"pageInfo": PageInfo,
"edges": [ClinicUserSchemaEdge]
}
}
}
clientStatsReport
Response
Returns a ClientStatsReportSchema!
Arguments
| Name | Description |
|---|---|
filter - ReportQueryFilter
|
Default = null |
Example
Query
query ClientStatsReport($filter: ReportQueryFilter) {
clientStatsReport(filter: $filter) {
genderTotals {
name
clientCount
}
ageGroupTotals {
name
clientCount
}
statusTotals {
name
clientCount
}
cityTotals {
name
clientCount
}
stateTotals {
name
clientCount
}
clientStatsReportItems {
gender
age
status
createdAt
city
state
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"clientStatsReport": {
"genderTotals": [ClientStatsNamedTotalSchema],
"ageGroupTotals": [ClientStatsNamedTotalSchema],
"statusTotals": [ClientStatsNamedTotalSchema],
"cityTotals": [ClientStatsNamedTotalSchema],
"stateTotals": [ClientStatsNamedTotalSchema],
"clientStatsReportItems": [
ClientStatsReportItemSchema
]
}
}
}
clients
Response
Returns [ClinicUserSchema!]!
Arguments
| Name | Description |
|---|---|
userStatus - [UserStatus!]!
|
Default = [] |
search - String
|
Default = null |
Example
Query
query Clients(
$userStatus: [UserStatus!]!,
$search: String
) {
clients(
userStatus: $userStatus,
search: $search
) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"userStatus": [""], "search": null}
Response
{
"data": {
"clients": [
{
"profilePicture": MediaSchema,
"id": 4,
"firstName": "xyz789",
"lastName": "abc123",
"emailH": "abc123",
"emailW": "abc123",
"phoneH": "xyz789",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": true,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
clientsByPhoneNum
Response
Returns [ClinicUserSchema!]!
Arguments
| Name | Description |
|---|---|
phoneNumber - String!
|
Example
Query
query ClientsByPhoneNum($phoneNumber: String!) {
clientsByPhoneNum(phoneNumber: $phoneNumber) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"phoneNumber": "xyz789"}
Response
{
"data": {
"clientsByPhoneNum": [
{
"profilePicture": MediaSchema,
"id": 4,
"firstName": "xyz789",
"lastName": "abc123",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
clientsPaginated
Response
Returns a ClinicUserViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - ClinicUserFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query ClientsPaginated(
$filter: ClinicUserFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
clientsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...ClinicUserViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"clientsPaginated": {
"pageInfo": PageInfo,
"edges": [ClinicUserViewSchemaEdge]
}
}
}
clinicEmployeeSchedule
Response
Returns [ScheduleSchema!]!
Arguments
| Name | Description |
|---|---|
employeeUid - ID!
|
|
type - ScheduleType!
|
Example
Query
query ClinicEmployeeSchedule(
$employeeUid: ID!,
$type: ScheduleType!
) {
clinicEmployeeSchedule(
employeeUid: $employeeUid,
type: $type
) {
scheduleId
type
creatorUid
employeeUid
startDatetime
endDatetime
fullDay
rrule
onlineBookingConfig {
enabled
appointmentTypesAllowed
}
createdAt
updatedAt
}
}
Variables
{"employeeUid": "4", "type": "WORK_HOURS"}
Response
{
"data": {
"clinicEmployeeSchedule": [
{
"scheduleId": "4",
"type": "WORK_HOURS",
"creatorUid": 4,
"employeeUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": false,
"rrule": "abc123",
"onlineBookingConfig": OnlineBookingConfigSchema,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
clinicEvents
Response
Returns [EventSchema!]!
Example
Query
query ClinicEvents(
$startDatetime: datetime!,
$endDatetime: datetime!
) {
clinicEvents(
startDatetime: $startDatetime,
endDatetime: $endDatetime
) {
type
scheduleId
employeeUid
creatorUid
startDatetime
endDatetime
fullDay
onlineBookingConfig {
enabled
appointmentTypesAllowed
}
employee {
id
firstName
lastName
employeeInfo {
...PublicEmployeeInfoSchemaFragment
}
}
}
}
Variables
{
"startDatetime": datetime,
"endDatetime": datetime
}
Response
{
"data": {
"clinicEvents": [
{
"type": "WORK_HOURS",
"scheduleId": 4,
"employeeUid": "4",
"creatorUid": 4,
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"onlineBookingConfig": OnlineBookingConfigSchema,
"employee": PublicClinicUserSchema
}
]
}
}
color
Response
Returns a ColorSchema!
Arguments
| Name | Description |
|---|---|
colorId - ID!
|
Example
Query
query Color($colorId: ID!) {
color(colorId: $colorId) {
colorId
name
species
}
}
Variables
{"colorId": 4}
Response
{
"data": {
"color": {
"colorId": "4",
"name": "abc123",
"species": "xyz789"
}
}
}
colors
Response
Returns [ColorSchema!]!
Arguments
| Name | Description |
|---|---|
species - String
|
Default = null |
Example
Query
query Colors($species: String) {
colors(species: $species) {
colorId
name
species
}
}
Variables
{"species": null}
Response
{
"data": {
"colors": [
{
"colorId": "4",
"name": "abc123",
"species": "abc123"
}
]
}
}
commissionSettingsByUser
Response
Returns [CommissionSettingViewSchema!]!
Arguments
| Name | Description |
|---|---|
input - CommissionSettingsByUserSchema!
|
Example
Query
query CommissionSettingsByUser($input: CommissionSettingsByUserSchema!) {
commissionSettingsByUser(input: $input) {
id
originalCommissionSettingId
typeName
typeCode
categoryName
categoryCode
treatmentId
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
type
commissionRate
userId
user {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": CommissionSettingsByUserSchema}
Response
{
"data": {
"commissionSettingsByUser": [
{
"id": "4",
"originalCommissionSettingId": 4,
"typeName": "abc123",
"typeCode": "xyz789",
"categoryName": "abc123",
"categoryCode": "xyz789",
"treatmentId": 4,
"treatment": TreatmentSchema,
"type": "TREATMENT",
"commissionRate": 987.65,
"userId": "4",
"user": ClinicUserSchema,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
commissionsPdf
Response
Returns a MediaSchema!
Example
Query
query CommissionsPdf(
$userIds: [ID!]!,
$fromDate: datetime!,
$toDate: datetime!,
$metric: Metric!,
$force: Boolean!
) {
commissionsPdf(
userIds: $userIds,
fromDate: $fromDate,
toDate: $toDate,
metric: $metric,
force: $force
) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{
"userIds": ["4"],
"fromDate": datetime,
"toDate": datetime,
"metric": "COMMISSION",
"force": false
}
Response
{
"data": {
"commissionsPdf": {
"url": "abc123",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "xyz789",
"deletedAt": "abc123",
"title": "xyz789",
"description": "abc123",
"summaryGeneratedByAi": false,
"transcript": "xyz789",
"key": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
communication
Response
Returns a CommunicationSchema!
Arguments
| Name | Description |
|---|---|
communicationId - ID!
|
Example
Query
query Communication($communicationId: ID!) {
communication(communicationId: $communicationId) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
callAnalytics {
summary
sentiment
transcript
}
communicationId
clientId
patientId
employeeId
communicationType
communication
contactDatetime
status
mediaId
mangoWebhookRequestId
voidReason
createdAt
updatedAt
}
}
Variables
{"communicationId": 4}
Response
{
"data": {
"communication": {
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"patient": PatientSchema,
"media": MediaSchema,
"callAnalytics": CallSummaryAnalyticsSchema,
"communicationId": "4",
"clientId": 4,
"patientId": 4,
"employeeId": 4,
"communicationType": "PHONE",
"communication": "xyz789",
"contactDatetime": datetime,
"status": "OPEN",
"mediaId": "4",
"mangoWebhookRequestId": "abc123",
"voidReason": "abc123",
"createdAt": datetime,
"updatedAt": datetime
}
}
}
communications
Response
Returns [CommunicationSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID
|
Default = null |
Example
Query
query Communications($patientId: ID) {
communications(patientId: $patientId) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
callAnalytics {
summary
sentiment
transcript
}
communicationId
clientId
patientId
employeeId
communicationType
communication
contactDatetime
status
mediaId
mangoWebhookRequestId
voidReason
createdAt
updatedAt
}
}
Variables
{"patientId": null}
Response
{
"data": {
"communications": [
{
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"patient": PatientSchema,
"media": MediaSchema,
"callAnalytics": CallSummaryAnalyticsSchema,
"communicationId": "4",
"clientId": "4",
"patientId": 4,
"employeeId": 4,
"communicationType": "PHONE",
"communication": "xyz789",
"contactDatetime": datetime,
"status": "OPEN",
"mediaId": 4,
"mangoWebhookRequestId": "xyz789",
"voidReason": "xyz789",
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
conversation
Response
Returns a ConversationSchema!
Example
Query
query Conversation(
$conversationId: ID,
$phoneNumber: String,
$clientId: ID
) {
conversation(
conversationId: $conversationId,
phoneNumber: $phoneNumber,
clientId: $clientId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"conversationId": null, "phoneNumber": null, "clientId": null}
Response
{
"data": {
"conversation": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": 4,
"unknownPhoneNumber": "abc123",
"isArchived": false,
"readAt": datetime,
"unreadCount": 987,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
conversations
Response
Returns a ConversationSchemaConnection!
Arguments
| Name | Description |
|---|---|
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query Conversations($paginationInfo: PaginationInfo) {
conversations(paginationInfo: $paginationInfo) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...ConversationSchemaFragment
}
cursor
}
}
}
Variables
{"paginationInfo": null}
Response
{
"data": {
"conversations": {
"pageInfo": PageInfo,
"edges": [ConversationSchemaEdge]
}
}
}
declinedTreatmentsPaginated
Response
Returns a DeclinedTreatmentViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - DeclinedTreatmentFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query DeclinedTreatmentsPaginated(
$filter: DeclinedTreatmentFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
declinedTreatmentsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...DeclinedTreatmentViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"declinedTreatmentsPaginated": {
"pageInfo": PageInfo,
"edges": [DeclinedTreatmentViewSchemaEdge]
}
}
}
diagnoses
Response
Returns [DiagnosisSchema!]!
Example
Query
query Diagnoses {
diagnoses {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
name
source
dischargeDocumentIds
creatorId
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"diagnoses": [
{
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"name": "xyz789",
"source": "AAHA",
"dischargeDocumentIds": ["4"],
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
diagnosesPaginated
Response
Returns a DiagnosisSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - DiagnosisViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query DiagnosesPaginated(
$filter: DiagnosisViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
diagnosesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...DiagnosisSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"diagnosesPaginated": {
"pageInfo": PageInfo,
"edges": [DiagnosisSchemaEdge]
}
}
}
diagnosis
Response
Returns a DiagnosisSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Diagnosis($id: ID!) {
diagnosis(id: $id) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
name
source
dischargeDocumentIds
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"diagnosis": {
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"name": "xyz789",
"source": "AAHA",
"dischargeDocumentIds": ["4"],
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
dischargeDocument
Response
Returns a DischargeDocumentSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query DischargeDocument($id: ID!) {
dischargeDocument(id: $id) {
linkedDiagnoses {
id
name
}
linkedTreatments {
treatmentId
name
species
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"dischargeDocument": {
"linkedDiagnoses": [DiagnosisBasicSchema],
"linkedTreatments": [TreatmentBasicSchema],
"id": 4,
"fileName": "xyz789",
"documentName": "xyz789",
"mediaId": 4,
"species": "abc123",
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
dischargeDocuments
Response
Returns [DischargeDocumentSchema!]!
Example
Query
query DischargeDocuments {
dischargeDocuments {
linkedDiagnoses {
id
name
}
linkedTreatments {
treatmentId
name
species
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"dischargeDocuments": [
{
"linkedDiagnoses": [DiagnosisBasicSchema],
"linkedTreatments": [TreatmentBasicSchema],
"id": "4",
"fileName": "xyz789",
"documentName": "abc123",
"mediaId": 4,
"species": "abc123",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
dischargeDocumentsPaginated
Response
Returns a DischargeDocumentSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - DischargeDocumentViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query DischargeDocumentsPaginated(
$filter: DischargeDocumentViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
dischargeDocumentsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...DischargeDocumentSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"dischargeDocumentsPaginated": {
"pageInfo": PageInfo,
"edges": [DischargeDocumentSchemaEdge]
}
}
}
emailLog
Response
Returns an EmailLogSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query EmailLog($id: ID!) {
emailLog(id: $id) {
attachments {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
sender
receiverEmails
patientId
subject
emailTemplateName
emailTemplateData
emailContent
attachmentIds
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"emailLog": {
"attachments": [MediaSchema],
"id": 4,
"sender": "abc123",
"receiverEmails": ["abc123"],
"patientId": 4,
"subject": "xyz789",
"emailTemplateName": "xyz789",
"emailTemplateData": {},
"emailContent": "xyz789",
"attachmentIds": [4],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
emailLogsPaginated
Response
Returns an EmailLogSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - EmailLogFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query EmailLogsPaginated(
$filter: EmailLogFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
emailLogsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...EmailLogSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"emailLogsPaginated": {
"pageInfo": PageInfo,
"edges": [EmailLogSchemaEdge]
}
}
}
emailTemplate
Response
Returns an EmailTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query EmailTemplate($id: ID!) {
emailTemplate(id: $id) {
postFooter
availableVariables
id
name
description
key
templateKey
enabled
type
replyTo
subject
body
bodyJson
footer
footerJson
linkedFormIds
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"emailTemplate": {
"postFooter": "abc123",
"availableVariables": {},
"id": "4",
"name": "xyz789",
"description": "abc123",
"key": "abc123",
"templateKey": "xyz789",
"enabled": false,
"type": "SYSTEM",
"replyTo": "xyz789",
"subject": "xyz789",
"body": "abc123",
"bodyJson": "xyz789",
"footer": "abc123",
"footerJson": "abc123",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
emailTemplates
Response
Returns [EmailTemplateSchema!]!
Example
Query
query EmailTemplates {
emailTemplates {
postFooter
availableVariables
id
name
description
key
templateKey
enabled
type
replyTo
subject
body
bodyJson
footer
footerJson
linkedFormIds
createdAt
updatedAt
}
}
Response
{
"data": {
"emailTemplates": [
{
"postFooter": "xyz789",
"availableVariables": {},
"id": 4,
"name": "xyz789",
"description": "abc123",
"key": "xyz789",
"templateKey": "abc123",
"enabled": true,
"type": "SYSTEM",
"replyTo": "xyz789",
"subject": "abc123",
"body": "abc123",
"bodyJson": "abc123",
"footer": "xyz789",
"footerJson": "abc123",
"linkedFormIds": [4],
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
employee
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Employee($id: ID!) {
employee(id: $id) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"id": 4}
Response
{
"data": {
"employee": {
"profilePicture": MediaSchema,
"id": "4",
"firstName": "xyz789",
"lastName": "abc123",
"emailH": "xyz789",
"emailW": "xyz789",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "abc123",
"state": "abc123",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": false,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
employees
Response
Returns [ClinicUserSchema!]!
Arguments
| Name | Description |
|---|---|
userStatus - [UserStatus!]!
|
Default = [] |
hideInCalendar - Boolean
|
Default = null |
Example
Query
query Employees(
$userStatus: [UserStatus!]!,
$hideInCalendar: Boolean
) {
employees(
userStatus: $userStatus,
hideInCalendar: $hideInCalendar
) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"userStatus": [""], "hideInCalendar": null}
Response
{
"data": {
"employees": [
{
"profilePicture": MediaSchema,
"id": "4",
"firstName": "xyz789",
"lastName": "xyz789",
"emailH": "xyz789",
"emailW": "abc123",
"phoneH": "abc123",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": false,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
estimate
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
estimateId - ID!
|
|
media - MediaQueryInputSchema
|
Default = null |
Example
Query
query Estimate(
$estimateId: ID!,
$media: MediaQueryInputSchema
) {
estimate(
estimateId: $estimateId,
media: $media
) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"estimateId": "4", "media": null}
Response
{
"data": {
"estimate": {
"soap": SoapSchema,
"estimateId": 4,
"status": "OPEN",
"patientId": "4",
"creatorUid": "4",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 987,
"maxSubtotal": 987,
"isTaxExempt": true,
"minTax": 987,
"maxTax": 987,
"minPstTax": 987,
"maxPstTax": 987,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 987,
"minTotal": 123,
"maxTotal": 987,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "abc123",
"clientId": 4,
"otherApproverName": "xyz789",
"media": [MediaSchema],
"title": "xyz789",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
estimatePdf
Response
Returns a MediaSchema!
Example
Query
query EstimatePdf(
$estimateId: ID!,
$patientId: ID!,
$familyId: ID!,
$force: Boolean!
) {
estimatePdf(
estimateId: $estimateId,
patientId: $patientId,
familyId: $familyId,
force: $force
) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{
"estimateId": 4,
"patientId": "4",
"familyId": 4,
"force": false
}
Response
{
"data": {
"estimatePdf": {
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "xyz789",
"visitNote": VisitNoteSchema,
"id": 4,
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "abc123",
"deletedAt": "xyz789",
"title": "abc123",
"description": "abc123",
"summaryGeneratedByAi": false,
"transcript": "xyz789",
"key": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
estimates
Response
Returns [EstimateSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID
|
Default = null |
media - MediaQueryInputSchema
|
Default = null |
Example
Query
query Estimates(
$patientId: ID,
$media: MediaQueryInputSchema
) {
estimates(
patientId: $patientId,
media: $media
) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"patientId": null, "media": null}
Response
{
"data": {
"estimates": [
{
"soap": SoapSchema,
"estimateId": "4",
"status": "OPEN",
"patientId": 4,
"creatorUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 987,
"maxSubtotal": 123,
"isTaxExempt": false,
"minTax": 123,
"maxTax": 123,
"minPstTax": 987,
"maxPstTax": 123,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 123,
"minTotal": 987,
"maxTotal": 987,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": 4,
"otherApproverName": "abc123",
"media": [MediaSchema],
"title": "abc123",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
estimatesByNoteId
Response
Returns [EstimateSchema!]!
Arguments
| Name | Description |
|---|---|
input - EstimatesByNoteIdInput!
|
Example
Query
query EstimatesByNoteId($input: EstimatesByNoteIdInput!) {
estimatesByNoteId(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimatesByNoteIdInput}
Response
{
"data": {
"estimatesByNoteId": [
{
"soap": SoapSchema,
"estimateId": 4,
"status": "OPEN",
"patientId": "4",
"creatorUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"items": [EstimateItemSchema],
"isRange": true,
"minSubtotal": 123,
"maxSubtotal": 987,
"isTaxExempt": false,
"minTax": 123,
"maxTax": 123,
"minPstTax": 987,
"maxPstTax": 987,
"taxRate": 123.45,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"minTotal": 987,
"maxTotal": 123,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "abc123",
"clientId": 4,
"otherApproverName": "xyz789",
"media": [MediaSchema],
"title": "abc123",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
expiringSoonList
Response
Returns [InventoriesOverviewSchema!]!
Example
Query
query ExpiringSoonList {
expiringSoonList {
id
isControlledSubstance
isRunningLow
type
pricePerUnit
unit
furthestExpiredAt
quantityRemaining
remainingValue
category
name
createdAt
}
}
Response
{
"data": {
"expiringSoonList": [
{
"id": "abc123",
"isControlledSubstance": true,
"isRunningLow": false,
"type": "xyz789",
"pricePerUnit": 987,
"unit": "ML",
"furthestExpiredAt": datetime,
"quantityRemaining": Decimal,
"remainingValue": 987,
"category": "abc123",
"name": "xyz789",
"createdAt": datetime
}
]
}
}
extensions
Response
Returns [Extension!]!
Example
Query
query Extensions {
extensions {
uuid
name
number
}
}
Response
{
"data": {
"extensions": [
{
"uuid": "abc123",
"name": "abc123",
"number": "abc123"
}
]
}
}
families
Response
Returns [FamilyViewSchema!]!
Example
Query
query Families {
families {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Response
{
"data": {
"families": [
{
"id": 4,
"familyId": 4,
"familyName": "abc123",
"familyNameLowercase": "abc123",
"familyExtId": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": 4,
"secondaryContactUid": 4,
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
]
}
}
familiesPaginated
Response
Returns a FamilyViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - FamilyFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query FamiliesPaginated(
$filter: FamilyFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
familiesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...FamilyViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"familiesPaginated": {
"pageInfo": PageInfo,
"edges": [FamilyViewSchemaEdge]
}
}
}
family
Response
Returns a FamilyViewSchema!
Arguments
| Name | Description |
|---|---|
familyId - ID!
|
Example
Query
query Family($familyId: ID!) {
family(familyId: $familyId) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{"familyId": "4"}
Response
{
"data": {
"family": {
"id": "4",
"familyId": 4,
"familyName": "abc123",
"familyNameLowercase": "xyz789",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 123,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": 4,
"secondaryContactUid": 4,
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
familyAppointments
Response
Returns [AppointmentViewSchema!]
Example
Query
query FamilyAppointments(
$familyId: ID!,
$includeHistory: Boolean,
$startDate: datetime,
$endDate: datetime,
$showCanceled: Boolean
) {
familyAppointments(
familyId: $familyId,
includeHistory: $includeHistory,
startDate: $startDate,
endDate: $endDate,
showCanceled: $showCanceled
) {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentTypeId
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
}
Variables
{
"familyId": "4",
"includeHistory": true,
"startDate": null,
"endDate": null,
"showCanceled": false
}
Response
{
"data": {
"familyAppointments": [
{
"id": "4",
"appointmentId": "4",
"creatorUid": "4",
"assignedUid": "4",
"patientId": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"status": "xyz789",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": false,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": true,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"assignedEmployee": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"appointmentTypeId": "4",
"appointmentType": AppointmentTypeResolveSchema,
"isOnlineRequest": true,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"isRecurring": false
}
]
}
}
familyInvoices
Response
Returns a FamilyInvoicesViewSchema!
Arguments
| Name | Description |
|---|---|
familyId - ID!
|
Example
Query
query FamilyInvoices($familyId: ID!) {
familyInvoices(familyId: $familyId) {
id
familyId
familyName
familyNameLowercase
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
}
}
Variables
{"familyId": 4}
Response
{
"data": {
"familyInvoices": {
"id": "4",
"familyId": 4,
"familyName": "xyz789",
"familyNameLowercase": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"balanceAmount": 123,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": 4,
"secondaryContactUid": 4,
"invoices": [InvoiceViewSchema]
}
}
}
familySubscriptions
Response
Returns [SubscriptionSchema!]!
Arguments
| Name | Description |
|---|---|
familyId - ID!
|
Example
Query
query FamilySubscriptions($familyId: ID!) {
familySubscriptions(familyId: $familyId) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"familyId": "4"}
Response
{
"data": {
"familySubscriptions": [
{
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "xyz789",
"accountId": "xyz789",
"customerId": "xyz789",
"status": "ACTIVE",
"price": 123,
"currency": "AUD",
"intervalUnit": "abc123",
"intervalCount": 123,
"paymentMethodId": "abc123",
"platformFeeAmount": 123,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
form
Response
Returns a FormSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Form($id: ID!) {
form(id: $id) {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"form": {
"id": "4",
"title": "abc123",
"description": "abc123",
"uiSchema": {},
"baseSchema": {},
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
formSubmission
Response
Returns a FormSubmissionViewSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query FormSubmission($id: ID!) {
formSubmission(id: $id) {
url
id
formId
formData
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
message
appointmentId
appointment {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
appointmentTypeId
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
status
publicId
sentVia
sentByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
form {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"formSubmission": {
"url": "abc123",
"id": "xyz789",
"formId": 4,
"formData": {},
"client": ClinicUserSchema,
"patient": PatientSchema,
"message": "xyz789",
"appointmentId": 4,
"appointment": AppointmentViewSchema,
"status": "SENT",
"publicId": "xyz789",
"sentVia": ["EMAIL"],
"sentByUser": ClinicUserSchema,
"form": FormSchema,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
formSubmissionByAppointmentId
Response
Returns [FormSubmissionViewSchema!]!
Arguments
| Name | Description |
|---|---|
appointmentId - ID!
|
Example
Query
query FormSubmissionByAppointmentId($appointmentId: ID!) {
formSubmissionByAppointmentId(appointmentId: $appointmentId) {
url
id
formId
formData
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
message
appointmentId
appointment {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
appointmentTypeId
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
status
publicId
sentVia
sentByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
form {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"appointmentId": "4"}
Response
{
"data": {
"formSubmissionByAppointmentId": [
{
"url": "xyz789",
"id": "abc123",
"formId": "4",
"formData": {},
"client": ClinicUserSchema,
"patient": PatientSchema,
"message": "xyz789",
"appointmentId": 4,
"appointment": AppointmentViewSchema,
"status": "SENT",
"publicId": "abc123",
"sentVia": ["EMAIL"],
"sentByUser": ClinicUserSchema,
"form": FormSchema,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
formSubmissionByPublicId
Response
Returns a FormSubmissionViewSchema!
Arguments
| Name | Description |
|---|---|
publicId - String!
|
Example
Query
query FormSubmissionByPublicId($publicId: String!) {
formSubmissionByPublicId(publicId: $publicId) {
url
id
formId
formData
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
message
appointmentId
appointment {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
appointmentTypeId
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
status
publicId
sentVia
sentByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
form {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"publicId": "abc123"}
Response
{
"data": {
"formSubmissionByPublicId": {
"url": "xyz789",
"id": "abc123",
"formId": 4,
"formData": {},
"client": ClinicUserSchema,
"patient": PatientSchema,
"message": "abc123",
"appointmentId": "4",
"appointment": AppointmentViewSchema,
"status": "SENT",
"publicId": "abc123",
"sentVia": ["EMAIL"],
"sentByUser": ClinicUserSchema,
"form": FormSchema,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
formSubmissionsBySoapId
Response
Returns [FormSubmissionViewSchema!]!
Arguments
| Name | Description |
|---|---|
soapId - ID!
|
Example
Query
query FormSubmissionsBySoapId($soapId: ID!) {
formSubmissionsBySoapId(soapId: $soapId) {
url
id
formId
formData
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
message
appointmentId
appointment {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
appointmentTypeId
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
status
publicId
sentVia
sentByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
form {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"soapId": "4"}
Response
{
"data": {
"formSubmissionsBySoapId": [
{
"url": "abc123",
"id": "xyz789",
"formId": 4,
"formData": {},
"client": ClinicUserSchema,
"patient": PatientSchema,
"message": "abc123",
"appointmentId": 4,
"appointment": AppointmentViewSchema,
"status": "SENT",
"publicId": "xyz789",
"sentVia": ["EMAIL"],
"sentByUser": ClinicUserSchema,
"form": FormSchema,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
formSubmissionsPaginated
Response
Returns a FormSubmissionViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - FormSubmissionViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query FormSubmissionsPaginated(
$filter: FormSubmissionViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
formSubmissionsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...FormSubmissionViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"formSubmissionsPaginated": {
"pageInfo": PageInfo,
"edges": [FormSubmissionViewSchemaEdge]
}
}
}
forms
Response
Returns [FormSchema!]!
Example
Query
query Forms {
forms {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"forms": [
{
"id": "4",
"title": "abc123",
"description": "xyz789",
"uiSchema": {},
"baseSchema": {},
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
formsPaginated
Response
Returns a FormViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - FormFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query FormsPaginated(
$filter: FormFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
formsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...FormViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"formsPaginated": {
"pageInfo": PageInfo,
"edges": [FormViewSchemaEdge]
}
}
}
freemium
Response
Returns a FreemiumSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Freemium($id: ID!) {
freemium(id: $id) {
id
name
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"freemium": {
"id": 4,
"name": "xyz789",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
freemiumsPaginated
Response
Returns a FreemiumSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - FreemiumFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query FreemiumsPaginated(
$filter: FreemiumFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
freemiumsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...FreemiumSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"freemiumsPaginated": {
"pageInfo": PageInfo,
"edges": [FreemiumSchemaEdge]
}
}
}
getAllPermissions
Response
Returns [PermissionSchema!]!
Example
Query
query GetAllPermissions {
getAllPermissions {
id
name
description
key
category
createdAt
updatedAt
}
}
Response
{
"data": {
"getAllPermissions": [
{
"id": 4,
"name": "xyz789",
"description": "abc123",
"key": "xyz789",
"category": "GENERAL",
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
getAllRoles
Response
Returns [RoleSchema!]!
Example
Query
query GetAllRoles {
getAllRoles {
id
name
permissions
systemRole
sisterClinics
createdAt
updatedAt
}
}
Response
{
"data": {
"getAllRoles": [
{
"id": 4,
"name": "xyz789",
"permissions": ["xyz789"],
"systemRole": true,
"sisterClinics": ["abc123"],
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
getAvailableAppointmentSlots
Response
Returns [EventSchema!]!
Example
Query
query GetAvailableAppointmentSlots(
$startDatetime: datetime!,
$endDatetime: datetime!,
$type: ID!,
$employeeId: ID
) {
getAvailableAppointmentSlots(
startDatetime: $startDatetime,
endDatetime: $endDatetime,
type: $type,
employeeId: $employeeId
) {
type
scheduleId
employeeUid
creatorUid
startDatetime
endDatetime
fullDay
onlineBookingConfig {
enabled
appointmentTypesAllowed
}
employee {
id
firstName
lastName
employeeInfo {
...PublicEmployeeInfoSchemaFragment
}
}
}
}
Variables
{
"startDatetime": datetime,
"endDatetime": datetime,
"type": "4",
"employeeId": null
}
Response
{
"data": {
"getAvailableAppointmentSlots": [
{
"type": "WORK_HOURS",
"scheduleId": 4,
"employeeUid": "4",
"creatorUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"onlineBookingConfig": OnlineBookingConfigSchema,
"employee": PublicClinicUserSchema
}
]
}
}
getMostRecentSoapAsTemplate
Response
Returns a SoapTemplateDataSchema
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query GetMostRecentSoapAsTemplate($patientId: ID!) {
getMostRecentSoapAsTemplate(patientId: $patientId) {
treatments {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
treatmentIds
recs
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"getMostRecentSoapAsTemplate": {
"treatments": [TreatmentSchema],
"details": "xyz789",
"subjective": "xyz789",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"treatmentIds": [4],
"recs": "abc123",
"patientDiagrams": [SoapSurgeryPatientDiagramSchema]
}
}
}
getMostRecentSurgeryAsTemplate
Response
Returns a SurgeryTemplateDataSchema
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query GetMostRecentSurgeryAsTemplate($patientId: ID!) {
getMostRecentSurgeryAsTemplate(patientId: $patientId) {
treatments {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
procedure
preopNotes
intraopMedicationNotes
intraopProcedureNotes
postopNotes
treatmentIds
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
}
}
Variables
{"patientId": 4}
Response
{
"data": {
"getMostRecentSurgeryAsTemplate": {
"treatments": [TreatmentSchema],
"procedure": "abc123",
"preopNotes": "abc123",
"intraopMedicationNotes": "abc123",
"intraopProcedureNotes": "abc123",
"postopNotes": "xyz789",
"treatmentIds": [4],
"patientDiagrams": [SoapSurgeryPatientDiagramSchema]
}
}
}
getMostRecentVisitNoteAsTemplate
Response
Returns a VisitNoteTemplateDataSchema
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query GetMostRecentVisitNoteAsTemplate($patientId: ID!) {
getMostRecentVisitNoteAsTemplate(patientId: $patientId) {
treatments {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
treatmentIds
}
}
Variables
{"patientId": 4}
Response
{
"data": {
"getMostRecentVisitNoteAsTemplate": {
"treatments": [TreatmentSchema],
"notes": "xyz789",
"details": "abc123",
"recs": "abc123",
"assessment": SoapAssessmentSchema,
"treatmentIds": ["4"]
}
}
}
getPatientBodyMap
Response
Returns [PatientProfileDiagramSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query GetPatientBodyMap($patientId: ID!) {
getPatientBodyMap(patientId: $patientId) {
id
title
species
type
mediaId
nectarDefault
creatorId
createdAt
updatedAt
deletedAt
annotations {
id
patientId
soapId
surgeryId
visitNoteId
patientDiagramId
description
color
status
previousId
coordinates
type
number
creatorId
resolverId
resolvedAt
resolveReason
createdAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"getPatientBodyMap": [
{
"id": 4,
"title": "xyz789",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": "4",
"nectarDefault": true,
"creatorId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"annotations": [PatientAnnotationSchema],
"media": MediaSchema
}
]
}
}
getRole
Response
Returns a RoleSchema!
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query GetRole($name: String!) {
getRole(name: $name) {
id
name
permissions
systemRole
sisterClinics
createdAt
updatedAt
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"getRole": {
"id": 4,
"name": "xyz789",
"permissions": ["abc123"],
"systemRole": true,
"sisterClinics": ["abc123"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
getUsersOnRole
Response
Returns [ClinicUserSchema!]!
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query GetUsersOnRole($name: String!) {
getUsersOnRole(name: $name) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"getUsersOnRole": [
{
"profilePicture": MediaSchema,
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"emailH": "xyz789",
"emailW": "xyz789",
"phoneH": "abc123",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "xyz789",
"state": "abc123",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
groupDiscount
Response
Returns a GroupDiscountSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GroupDiscount($id: ID!) {
groupDiscount(id: $id) {
id
name
percentage
creatorId
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"groupDiscount": {
"id": 4,
"name": "abc123",
"percentage": Decimal,
"creatorId": "4",
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
groupDiscounts
Response
Returns [GroupDiscountSchema!]!
Example
Query
query GroupDiscounts {
groupDiscounts {
id
name
percentage
creatorId
status
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"groupDiscounts": [
{
"id": "4",
"name": "xyz789",
"percentage": Decimal,
"creatorId": 4,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
groupDiscountsPaginated
Response
Returns a GroupDiscountViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - GroupDiscountViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query GroupDiscountsPaginated(
$filter: GroupDiscountViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
groupDiscountsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...GroupDiscountViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"groupDiscountsPaginated": {
"pageInfo": PageInfo,
"edges": [GroupDiscountViewSchemaEdge]
}
}
}
hasGlobalUnreadMessages
hasUnreadMessages
hl7iProviders
Response
Returns [HL7ProviderSchema!]!
Arguments
| Name | Description |
|---|---|
vendor - LabVendor!
|
Example
Query
query Hl7iProviders($vendor: LabVendor!) {
hl7iProviders(vendor: $vendor) {
id
firstName
lastName
clinicProviderId
updatedAt
}
}
Variables
{"vendor": "OTHER"}
Response
{
"data": {
"hl7iProviders": [
{
"id": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"clinicProviderId": "xyz789",
"updatedAt": datetime
}
]
}
}
incompleteFormSubmissionsByPatientId
Response
Returns [FormSubmissionViewSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query IncompleteFormSubmissionsByPatientId($patientId: ID!) {
incompleteFormSubmissionsByPatientId(patientId: $patientId) {
url
id
formId
formData
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
message
appointmentId
appointment {
id
appointmentId
creatorUid
assignedUid
patientId
soapId
surgeryId
visitNoteId
status
startDatetime
endDatetime
fullDay
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
smsReminderNotifId
createdAt
updatedAt
assignedEmployee {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
appointmentTypeId
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
isRecurring
}
status
publicId
sentVia
sentByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
form {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"incompleteFormSubmissionsByPatientId": [
{
"url": "abc123",
"id": "xyz789",
"formId": 4,
"formData": {},
"client": ClinicUserSchema,
"patient": PatientSchema,
"message": "xyz789",
"appointmentId": "4",
"appointment": AppointmentViewSchema,
"status": "SENT",
"publicId": "abc123",
"sentVia": ["EMAIL"],
"sentByUser": ClinicUserSchema,
"form": FormSchema,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
inventoryItems
Response
Returns [InventoryItemSchema!]!
Arguments
| Name | Description |
|---|---|
treatmentId - ID
|
Example
Query
query InventoryItems($treatmentId: ID) {
inventoryItems(treatmentId: $treatmentId) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
unitCost
totalCost
sku
uom
inventoryQuantities {
vendorId
locationId
quantityOnHand
sellRatio
createdAt
updatedAt
}
inventoryLot {
lotId
manufacturer
serialNo
ndcNumber
quantityReceived
quantityRemaining
expiredAt
receivedAt
manufacturedAt
deletedAt
createdAt
updatedAt
}
treatmentId
deletedAt
createdAt
updatedAt
}
}
Variables
{"treatmentId": "4"}
Response
{
"data": {
"inventoryItems": [
{
"treatment": TreatmentSchema,
"id": 4,
"unitCost": 987,
"totalCost": 987,
"sku": "xyz789",
"uom": "xyz789",
"inventoryQuantities": [InventoryQuantitySchema],
"inventoryLot": InventoryLotSchema,
"treatmentId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
inventoryItemsPaginated
Response
Returns an InventoryItemSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - InventoryItemFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query InventoryItemsPaginated(
$filter: InventoryItemFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
inventoryItemsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...InventoryItemSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"inventoryItemsPaginated": {
"pageInfo": PageInfo,
"edges": [InventoryItemSchemaEdge]
}
}
}
inventoryOverview
Response
Returns an InventoriesOverviewSchema!
Arguments
| Name | Description |
|---|---|
treatmentId - ID!
|
Example
Query
query InventoryOverview($treatmentId: ID!) {
inventoryOverview(treatmentId: $treatmentId) {
id
isControlledSubstance
isRunningLow
type
pricePerUnit
unit
furthestExpiredAt
quantityRemaining
remainingValue
category
name
createdAt
}
}
Variables
{"treatmentId": 4}
Response
{
"data": {
"inventoryOverview": {
"id": "xyz789",
"isControlledSubstance": true,
"isRunningLow": true,
"type": "abc123",
"pricePerUnit": 123,
"unit": "ML",
"furthestExpiredAt": datetime,
"quantityRemaining": Decimal,
"remainingValue": 123,
"category": "xyz789",
"name": "xyz789",
"createdAt": datetime
}
}
}
inventoryOverviews
Response
Returns [InventoriesOverviewSchema!]!
Example
Query
query InventoryOverviews {
inventoryOverviews {
id
isControlledSubstance
isRunningLow
type
pricePerUnit
unit
furthestExpiredAt
quantityRemaining
remainingValue
category
name
createdAt
}
}
Response
{
"data": {
"inventoryOverviews": [
{
"id": "xyz789",
"isControlledSubstance": true,
"isRunningLow": true,
"type": "xyz789",
"pricePerUnit": 987,
"unit": "ML",
"furthestExpiredAt": datetime,
"quantityRemaining": Decimal,
"remainingValue": 123,
"category": "xyz789",
"name": "abc123",
"createdAt": datetime
}
]
}
}
inventoryOverviewsPaginated
Response
Returns an InventoriesOverviewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - InventoriesOverviewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query InventoryOverviewsPaginated(
$filter: InventoriesOverviewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
inventoryOverviewsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...InventoriesOverviewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"inventoryOverviewsPaginated": {
"pageInfo": PageInfo,
"edges": [InventoriesOverviewSchemaEdge]
}
}
}
inventoryTransactions
Response
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query InventoryTransactions($id: ID!) {
inventoryTransactions(id: $id) {
id
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
clientId
invoiceId
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
inventoryItem {
treatment {
...TreatmentSchemaFragment
}
id
unitCost
totalCost
sku
uom
inventoryQuantities {
...InventoryQuantitySchemaFragment
}
inventoryLot {
...InventoryLotSchemaFragment
}
treatmentId
deletedAt
createdAt
updatedAt
}
reason
quantity
unitCost
cost
description
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"inventoryTransactions": [
{
"id": "abc123",
"creator": ClinicUserSchema,
"invoice": InvoiceSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"patientId": "4",
"clientId": "4",
"invoiceId": 4,
"treatment": TreatmentSchema,
"inventoryItem": InventoryItemSchema,
"reason": "WASTAGE",
"quantity": Decimal,
"unitCost": 987,
"cost": 987,
"description": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
inventoryTransactionsPaginated
Response
Returns an InventoryTransactionViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - InventoryTransactionViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query InventoryTransactionsPaginated(
$filter: InventoryTransactionViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
inventoryTransactionsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...InventoryTransactionViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"inventoryTransactionsPaginated": {
"pageInfo": PageInfo,
"edges": [InventoryTransactionViewSchemaEdge]
}
}
}
invoice
Response
Returns an InvoiceViewSchema!
Arguments
| Name | Description |
|---|---|
invoiceId - ID!
|
Example
Query
query Invoice($invoiceId: ID!) {
invoice(invoiceId: $invoiceId) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
}
Variables
{"invoiceId": 4}
Response
{
"data": {
"invoice": {
"soap": SoapSchema,
"surgery": SurgerySchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"id": "4",
"invoiceId": 4,
"status": "OPEN",
"patientId": "4",
"clientId": 4,
"creatorUid": "4",
"voidedUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"estimateId": "4",
"parentInvoiceId": "4",
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": true,
"tax": 987,
"taxRate": 987.65,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 987,
"discount": 987,
"total": 123,
"totalPaid": 123,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": true,
"storeCreditApplied": 123,
"storeCreditManuallySet": true,
"voidedAt": "xyz789",
"notes": "xyz789",
"patient": PatientSchema,
"client": ClinicUserSchema,
"family": FamilySchema,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": true,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"invoicedAt": datetime
}
}
}
invoices
Response
Returns [InvoiceViewSchema!]!
Example
Query
query Invoices(
$soapId: ID,
$surgeryId: ID,
$estimateId: ID,
$familyId: ID,
$status: InvoiceStatusEnum,
$onlyWithOutstandingBalance: Boolean
) {
invoices(
soapId: $soapId,
surgeryId: $surgeryId,
estimateId: $estimateId,
familyId: $familyId,
status: $status,
onlyWithOutstandingBalance: $onlyWithOutstandingBalance
) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
}
Variables
{
"soapId": null,
"surgeryId": null,
"estimateId": null,
"familyId": null,
"status": "null",
"onlyWithOutstandingBalance": false
}
Response
{
"data": {
"invoices": [
{
"soap": SoapSchema,
"surgery": SurgerySchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"id": "4",
"invoiceId": 4,
"status": "OPEN",
"patientId": 4,
"clientId": "4",
"creatorUid": 4,
"voidedUid": "4",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": false,
"tax": 987,
"taxRate": 987.65,
"pstTax": 123,
"pstTaxRate": 987.65,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 987,
"total": 987,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 123,
"outstandingBalance": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": true,
"storeCreditApplied": 123,
"storeCreditManuallySet": true,
"voidedAt": "xyz789",
"notes": "abc123",
"patient": PatientSchema,
"client": ClinicUserSchema,
"family": FamilySchema,
"title": "abc123",
"isInterestCharge": false,
"isMigrated": false,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"invoicedAt": datetime
}
]
}
}
invoicesByNoteId
Response
Returns [InvoiceViewSchema!]!
Arguments
| Name | Description |
|---|---|
input - InvoicesByNoteIdInput!
|
Example
Query
query InvoicesByNoteId($input: InvoicesByNoteIdInput!) {
invoicesByNoteId(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
}
Variables
{"input": InvoicesByNoteIdInput}
Response
{
"data": {
"invoicesByNoteId": [
{
"soap": SoapSchema,
"surgery": SurgerySchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"id": "4",
"invoiceId": "4",
"status": "OPEN",
"patientId": 4,
"clientId": "4",
"creatorUid": "4",
"voidedUid": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": 4,
"estimateId": 4,
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 123,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 123,
"total": 123,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": false,
"voidedAt": "abc123",
"notes": "abc123",
"patient": PatientSchema,
"client": ClinicUserSchema,
"family": FamilySchema,
"title": "abc123",
"isInterestCharge": false,
"isMigrated": true,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"invoicedAt": datetime
}
]
}
}
invoicesPaginated
Response
Returns an InvoiceViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - InvoiceViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query InvoicesPaginated(
$filter: InvoiceViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
invoicesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...InvoiceViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"invoicesPaginated": {
"pageInfo": PageInfo,
"edges": [InvoiceViewSchemaEdge]
}
}
}
kennel
Response
Returns a KennelSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Kennel($id: ID!) {
kennel(id: $id) {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"kennel": {
"id": 4,
"order": 987,
"kennelType": "abc123",
"description": "xyz789",
"species": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
kennels
Response
Returns [KennelSchema!]!
Example
Query
query Kennels {
kennels {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"kennels": [
{
"id": "4",
"order": 123,
"kennelType": "abc123",
"description": "xyz789",
"species": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
kennelsPaginated
Response
Returns a KennelViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - KennelViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query KennelsPaginated(
$filter: KennelViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
kennelsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...KennelViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"kennelsPaginated": {
"pageInfo": PageInfo,
"edges": [KennelViewSchemaEdge]
}
}
}
lab
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Lab($id: ID!) {
lab(id: $id) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"lab": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "xyz789",
"resultPdfUrl": "xyz789",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "xyz789",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "xyz789",
"idexxResultUrl": "abc123",
"id": "4",
"treatmentId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"patientId": 4,
"instructions": "xyz789",
"isStaff": false,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
}
}
labDevices
Response
Returns [LabDeviceSchema!]!
Arguments
| Name | Description |
|---|---|
vendor - LabVendor!
|
Example
Query
query LabDevices($vendor: LabVendor!) {
labDevices(vendor: $vendor) {
labTests {
listPrice
id
vendor
code
name
labCat
price
highlights {
...HighlightFragment
}
}
id
vendor
serialNumber
displayName
}
}
Variables
{"vendor": "OTHER"}
Response
{
"data": {
"labDevices": [
{
"labTests": [LabTestSchema],
"id": 4,
"vendor": "OTHER",
"serialNumber": "abc123",
"displayName": "xyz789"
}
]
}
}
labResult
Response
Returns a LabResultSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query LabResult($id: ID!) {
labResult(id: $id) {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"labResult": {
"id": 4,
"labId": "4",
"labName": "abc123",
"referenceLow": "xyz789",
"referenceCriticalLow": "abc123",
"referenceHigh": "xyz789",
"referenceCriticalHigh": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"categoryName": "xyz789",
"categoryCode": "xyz789",
"name": "xyz789",
"code": "xyz789",
"result": "xyz789",
"resultText": "abc123",
"indicator": "xyz789",
"units": "xyz789",
"referenceRange": "abc123",
"comments": ["xyz789"],
"order": 987,
"status": "abc123",
"deletedAt": datetime
}
}
}
labResults
Response
Returns [LabResultSchema!]!
Arguments
| Name | Description |
|---|---|
labId - ID
|
Example
Query
query LabResults($labId: ID) {
labResults(labId: $labId) {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
}
Variables
{"labId": 4}
Response
{
"data": {
"labResults": [
{
"id": 4,
"labId": "4",
"labName": "abc123",
"referenceLow": "abc123",
"referenceCriticalLow": "abc123",
"referenceHigh": "abc123",
"referenceCriticalHigh": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"categoryName": "xyz789",
"categoryCode": "abc123",
"name": "xyz789",
"code": "abc123",
"result": "xyz789",
"resultText": "abc123",
"indicator": "abc123",
"units": "abc123",
"referenceRange": "xyz789",
"comments": ["xyz789"],
"order": 123,
"status": "abc123",
"deletedAt": datetime
}
]
}
}
labTests
Response
Returns [LabTestSchema!]!
Arguments
| Name | Description |
|---|---|
vendor - LabVendor
|
Default = null |
Example
Query
query LabTests($vendor: LabVendor) {
labTests(vendor: $vendor) {
listPrice
id
vendor
code
name
labCat
price
highlights {
path
texts {
...TextFragment
}
score
}
}
}
Variables
{"vendor": "null"}
Response
{
"data": {
"labTests": [
{
"listPrice": 987,
"id": "abc123",
"vendor": "OTHER",
"code": "xyz789",
"name": "abc123",
"labCat": "IN_HOUSE",
"price": 987,
"highlights": [Highlight]
}
]
}
}
labTestsSearch
Response
Returns a LabTestSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - LabTestSearchFilterInput!
|
|
sort - LabTestSortEnum!
|
Default = CODE_ASC |
pagination - PaginationFilter
|
Default = null |
Example
Query
query LabTestsSearch(
$filter: LabTestSearchFilterInput!,
$sort: LabTestSortEnum!,
$pagination: PaginationFilter
) {
labTestsSearch(
filter: $filter,
sort: $sort,
pagination: $pagination
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...LabTestSchemaFragment
}
cursor
}
}
}
Variables
{
"filter": LabTestSearchFilterInput,
"sort": "CODE_ASC",
"pagination": null
}
Response
{
"data": {
"labTestsSearch": {
"pageInfo": PageInfo,
"edges": [LabTestSchemaEdge]
}
}
}
labs
Response
Returns [LabSchema!]!
Example
Query
query Labs(
$patientId: ID,
$soapId: ID,
$surgeryId: ID,
$sort: String
) {
labs(
patientId: $patientId,
soapId: $soapId,
surgeryId: $surgeryId,
sort: $sort
) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"patientId": null, "soapId": null, "surgeryId": null, "sort": "-_id"}
Response
{
"data": {
"labs": [
{
"idexxUiUrl": "xyz789",
"orderPdfUrl": "xyz789",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "abc123",
"notes": "abc123",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "xyz789",
"id": "4",
"treatmentId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": [4],
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"patientId": "4",
"instructions": "abc123",
"isStaff": true,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
]
}
}
labsPaginated
Response
Returns a LabSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - LabFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query LabsPaginated(
$filter: LabFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
labsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...LabSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"labsPaginated": {
"pageInfo": PageInfo,
"edges": [LabSchemaEdge]
}
}
}
locations
Response
Returns [LocationSchema!]!
Example
Query
query Locations {
locations {
id
name
description
deletedAt
}
}
Response
{
"data": {
"locations": [
{
"id": "4",
"name": "abc123",
"description": "xyz789",
"deletedAt": datetime
}
]
}
}
locationsPaginated
Response
Returns a LocationSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - LocationFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query LocationsPaginated(
$filter: LocationFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
locationsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...LocationSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"locationsPaginated": {
"pageInfo": PageInfo,
"edges": [LocationSchemaEdge]
}
}
}
media
Response
Returns a MediaSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Media($id: ID!) {
media(id: $id) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"media": {
"url": "abc123",
"signedPostUrl": "xyz789",
"bucket": "xyz789",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "xyz789",
"filename": "xyz789",
"deletedAt": "abc123",
"title": "xyz789",
"description": "abc123",
"summaryGeneratedByAi": true,
"transcript": "xyz789",
"key": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
medias
Response
Returns [MediaSchema!]!
Arguments
| Name | Description |
|---|---|
mediaIds - [ID!]!
|
Example
Query
query Medias($mediaIds: [ID!]!) {
medias(mediaIds: $mediaIds) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"mediaIds": [4]}
Response
{
"data": {
"medias": [
{
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": 4,
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "xyz789",
"filename": "abc123",
"deletedAt": "xyz789",
"title": "abc123",
"description": "abc123",
"summaryGeneratedByAi": false,
"transcript": "abc123",
"key": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
medicalHistoriesPaginated
Response
Returns a MedicalHistoryViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - MedicalHistoryViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query MedicalHistoriesPaginated(
$filter: MedicalHistoryViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
medicalHistoriesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...MedicalHistoryViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"medicalHistoriesPaginated": {
"pageInfo": PageInfo,
"edges": [MedicalHistoryViewSchemaEdge]
}
}
}
medicalHistory
Response
Returns a MedicalHistoryViewSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query MedicalHistory($id: ID!) {
medicalHistory(id: $id) {
origItems {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on LabResultSchema {
...LabResultSchemaFragment
}
... on PrescriptionOrderSchema {
...PrescriptionOrderSchemaFragment
}
... on PrescriptionFillSchema {
...PrescriptionFillSchemaFragment
}
... on MiscNoteSchema {
...MiscNoteSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on MediaSchema {
...MediaSchemaFragment
}
... on FormSubmissionViewSchema {
...FormSubmissionViewSchemaFragment
}
... on XraySchema {
...XraySchemaFragment
}
... on PatientVitalSchema {
...PatientVitalSchemaFragment
}
... on TaskSchema {
...TaskSchemaFragment
}
... on LinkSchema {
...LinkSchemaFragment
}
... on TreatmentPlanViewSchema {
...TreatmentPlanViewSchemaFragment
}
... on EmailLogSchema {
...EmailLogSchemaFragment
}
}
id
patientId
type
origItemIds
deletedAt
createdAt
updatedAt
displayDate
displayString
}
}
Variables
{"id": 4}
Response
{
"data": {
"medicalHistory": {
"origItems": [CommunicationSchema],
"id": "4",
"patientId": 4,
"type": "SOAP_NOTE",
"origItemIds": [4],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"displayDate": datetime,
"displayString": "xyz789"
}
}
}
mediums
Response
Returns [MediaSchema!]!
Arguments
| Name | Description |
|---|---|
resourceId - ID!
|
|
groupTypes - [GroupTypes!]
|
Default = null |
status - MediaStatus
|
Default = DONE |
Example
Query
query Mediums(
$resourceId: ID!,
$groupTypes: [GroupTypes!],
$status: MediaStatus
) {
mediums(
resourceId: $resourceId,
groupTypes: $groupTypes,
status: $status
) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"resourceId": 4, "groupTypes": ["ul"], "status": "DONE"}
Response
{
"data": {
"mediums": [
{
"url": "abc123",
"signedPostUrl": "xyz789",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "xyz789",
"filename": "xyz789",
"deletedAt": "abc123",
"title": "abc123",
"description": "abc123",
"summaryGeneratedByAi": true,
"transcript": "xyz789",
"key": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
]
}
}
messages
Response
Returns a ConversationMessageSchemaConnection!
Arguments
| Name | Description |
|---|---|
conversationId - ID!
|
|
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query Messages(
$conversationId: ID!,
$paginationInfo: PaginationInfo
) {
messages(
conversationId: $conversationId,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...ConversationMessageSchemaFragment
}
cursor
}
}
}
Variables
{"conversationId": 4, "paginationInfo": null}
Response
{
"data": {
"messages": {
"pageInfo": PageInfo,
"edges": [ConversationMessageSchemaEdge]
}
}
}
messagesByIds
Response
Returns [ConversationMessageSchema!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
query MessagesByIds($ids: [ID!]!) {
messagesByIds(ids: $ids) {
updateType
conversation {
assignedParticipants {
...ConversationParticipantSchemaFragment
}
updateType
participants {
...ConversationParticipantSchemaFragment
}
messages {
...ConversationMessageSchemaConnectionFragment
}
client {
...ClinicUserSchemaFragment
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
medias {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
messageType
createdAt
updatedAt
fromPhoneNumber
toPhoneNumber
conversationId
body
mediaIds
patientHistoryItemIds
employeeId
status
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"messagesByIds": [
{
"updateType": "NEW",
"conversation": ConversationSchema,
"employee": ClinicUserSchema,
"medias": [MediaSchema],
"id": "4",
"messageType": "SMS",
"createdAt": datetime,
"updatedAt": datetime,
"fromPhoneNumber": "xyz789",
"toPhoneNumber": "abc123",
"conversationId": "4",
"body": "xyz789",
"mediaIds": ["4"],
"patientHistoryItemIds": ["4"],
"employeeId": 4,
"status": "ACCEPTED"
}
]
}
}
nectarpayReport
Response
Returns a NectarpayReportSchema!
Arguments
| Name | Description |
|---|---|
filter - TransactionQueryFilter
|
Default = null |
Example
Query
query NectarpayReport($filter: TransactionQueryFilter) {
nectarpayReport(filter: $filter) {
nectarpayByPaymentType {
id
amount
count
transactions {
...NectarpayTransactionSchemaFragment
}
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"nectarpayReport": {
"nectarpayByPaymentType": [NectarpayPaymentTypeInfo]
}
}
}
ongoingDiagnosesByPatient
Response
Returns [OngoingDiagnosisViewSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
|
status - OngoingDiagnosisStatus
|
Default = null |
Example
Query
query OngoingDiagnosesByPatient(
$patientId: ID!,
$status: OngoingDiagnosisStatus
) {
ongoingDiagnosesByPatient(
patientId: $patientId,
status: $status
) {
id
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
diagnosis {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
name
source
dischargeDocumentIds
}
diagnosisDate
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"patientId": "4", "status": "null"}
Response
{
"data": {
"ongoingDiagnosesByPatient": [
{
"id": "4",
"creator": ClinicUserSchema,
"patient": PatientSchema,
"diagnosis": DiagnosisEntrySchema,
"diagnosisDate": datetime,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
ongoingDiagnosis
Response
Returns an OngoingDiagnosisSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query OngoingDiagnosis($id: ID!) {
ongoingDiagnosis(id: $id) {
id
creatorId
patientId
diagnosis {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
name
source
dischargeDocumentIds
}
diagnosisDate
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"ongoingDiagnosis": {
"id": 4,
"creatorId": "4",
"patientId": "4",
"diagnosis": DiagnosisEntrySchema,
"diagnosisDate": datetime,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
orderNote
Response
Returns an OrderNoteSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query OrderNote($id: ID!) {
orderNote(id: $id) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
notes
}
}
Variables
{"id": 4}
Response
{
"data": {
"orderNote": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": 4,
"techUid": "4",
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"notes": "xyz789"
}
}
}
orderNotes
Response
Returns [OrderNoteSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query OrderNotes($patientId: ID!) {
orderNotes(patientId: $patientId) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
notes
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"orderNotes": [
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": "4",
"creatorUid": 4,
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"notes": "abc123"
}
]
}
}
patient
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query Patient($patientId: ID!) {
patient(patientId: $patientId) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"patient": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": 4,
"extId": "abc123",
"familyId": 4,
"contactUid": 4,
"firstName": "abc123",
"status": "ACTIVE",
"species": "abc123",
"lastName": "abc123",
"breed": "xyz789",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": true,
"photoUrl": "xyz789",
"warnings": "abc123",
"microchip": "xyz789",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
patientAnnotation
Response
Returns a PatientAnnotationSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query PatientAnnotation($id: ID!) {
patientAnnotation(id: $id) {
id
patientId
soapId
surgeryId
visitNoteId
patientDiagramId
description
color
status
previousId
coordinates
type
number
creatorId
resolverId
resolvedAt
resolveReason
createdAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"patientAnnotation": {
"id": 4,
"patientId": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"patientDiagramId": "4",
"description": "abc123",
"color": "abc123",
"status": "OPEN",
"previousId": 4,
"coordinates": {},
"type": "BODY_DIAGRAM",
"number": "abc123",
"creatorId": 4,
"resolverId": 4,
"resolvedAt": datetime,
"resolveReason": "abc123",
"createdAt": datetime
}
}
}
patientAnnotations
Response
Returns a PatientAnnotationSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - PatientAnnotationFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query PatientAnnotations(
$filter: PatientAnnotationFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
patientAnnotations(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PatientAnnotationSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"patientAnnotations": {
"pageInfo": PageInfo,
"edges": [PatientAnnotationSchemaEdge]
}
}
}
patientDiagram
Response
Returns a PatientDiagramViewSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query PatientDiagram($id: ID!) {
patientDiagram(id: $id) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
title
species
type
mediaId
nectarDefault
creatorId
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdAt
updatedAt
deletedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"patientDiagram": {
"media": MediaSchema,
"id": 4,
"title": "xyz789",
"species": "xyz789",
"type": "BODY_DIAGRAM",
"mediaId": 4,
"nectarDefault": false,
"creatorId": "4",
"creator": ClinicUserSchema,
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
}
}
patientDiagrams
Response
Returns a PatientDiagramViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - PatientDiagramFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query PatientDiagrams(
$filter: PatientDiagramFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
patientDiagrams(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PatientDiagramViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"patientDiagrams": {
"pageInfo": PageInfo,
"edges": [PatientDiagramViewSchemaEdge]
}
}
}
patientDocuments
Response
Returns a PatientDocumentsSchema!
Example
Query
query PatientDocuments(
$patientId: ID!,
$startDatetime: datetime!,
$endDatetime: datetime!
) {
patientDocuments(
patientId: $patientId,
startDatetime: $startDatetime,
endDatetime: $endDatetime
) {
rxScripts {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
invoices {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
estimates {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
soaps {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
surgeries {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
visitNotes {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
vaccines {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
dischargeDocuments {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
}
}
Variables
{
"patientId": "4",
"startDatetime": datetime,
"endDatetime": datetime
}
Response
{
"data": {
"patientDocuments": {
"rxScripts": [CommunicationSchema],
"invoices": [CommunicationSchema],
"estimates": [CommunicationSchema],
"soaps": [CommunicationSchema],
"surgeries": [CommunicationSchema],
"visitNotes": [CommunicationSchema],
"vaccines": [CommunicationSchema],
"dischargeDocuments": [CommunicationSchema]
}
}
}
patientFamily
Response
Returns a FamilyViewSchema!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query PatientFamily($patientId: ID!) {
patientFamily(patientId: $patientId) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"patientFamily": {
"id": "4",
"familyId": 4,
"familyName": "xyz789",
"familyNameLowercase": "abc123",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": 4,
"secondaryContactUid": "4",
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
patientHistory
Response
Returns a PatientHistoryItemSchemaConnection!
Example
Query
query PatientHistory(
$patientId: ID!,
$first: Int!,
$after: String,
$before: String,
$type: PatientHistoryItemTypeEnum,
$sort: String,
$latest: Boolean
) {
patientHistory(
patientId: $patientId,
first: $first,
after: $after,
before: $before,
type: $type,
sort: $sort,
latest: $latest
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PatientHistoryItemSchemaFragment
}
cursor
}
}
}
Variables
{
"patientId": 4,
"first": 20,
"after": null,
"before": null,
"type": "null",
"sort": "-_id",
"latest": true
}
Response
{
"data": {
"patientHistory": {
"pageInfo": PageInfo,
"edges": [PatientHistoryItemSchemaEdge]
}
}
}
patientHistoryPaginated
Response
Arguments
| Name | Description |
|---|---|
filter - PatientHistoryFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query PatientHistoryPaginated(
$filter: PatientHistoryFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
patientHistoryPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PatientHistoryItemPaginatedSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"patientHistoryPaginated": {
"pageInfo": PageInfo,
"edges": [PatientHistoryItemPaginatedSchemaEdge]
}
}
}
patientMulti
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query PatientMulti($patientId: ID!) {
patientMulti(patientId: $patientId) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"patientMulti": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": false,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "abc123",
"familyId": "4",
"contactUid": 4,
"firstName": "abc123",
"status": "ACTIVE",
"species": "xyz789",
"lastName": "abc123",
"breed": "abc123",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": true,
"photoUrl": "abc123",
"warnings": "xyz789",
"microchip": "xyz789",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
patientOpenMedicalNotes
Response
Returns an OpenMedicalNotesResponse!
Example
Query
query PatientOpenMedicalNotes(
$patientId: ID!,
$limit: Int
) {
patientOpenMedicalNotes(
patientId: $patientId,
limit: $limit
) {
openNotes {
origItem {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
origItems {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on InvoiceSchema {
...InvoiceSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on DischargeDocumentSchema {
...DischargeDocumentSchemaFragment
}
}
patientHistoryItemId
patientId
origItemId
type
status
displayString
createdAt
origItemIds
}
totalCount
}
}
Variables
{"patientId": "4", "limit": 10}
Response
{
"data": {
"patientOpenMedicalNotes": {
"openNotes": [PatientHistoryItemPaginatedSchema],
"totalCount": 123
}
}
}
patientReport
Response
Returns a PatientReportSchema!
Arguments
| Name | Description |
|---|---|
filter - ReportQueryFilter
|
Default = null |
Example
Query
query PatientReport($filter: ReportQueryFilter) {
patientReport(filter: $filter) {
newAndExistingPatientTotals {
name
newPatientCount
existingPatientCount
activePatientCount
lapsingPatientCount
lapsedPatientCount
}
activeLapsingLapsedPatientTotals {
name
newPatientCount
existingPatientCount
activePatientCount
lapsingPatientCount
lapsedPatientCount
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"patientReport": {
"newAndExistingPatientTotals": [
PatientReportNamedTotalSchema
],
"activeLapsingLapsedPatientTotals": [
PatientReportNamedTotalSchema
]
}
}
}
patientSearch
Response
Returns a PatientSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - PatientQueryFilter
|
Default = null |
sort - String
|
Default = "-_id" |
pagination - PaginationFilter
|
Default = null |
Example
Query
query PatientSearch(
$filter: PatientQueryFilter,
$sort: String,
$pagination: PaginationFilter
) {
patientSearch(
filter: $filter,
sort: $sort,
pagination: $pagination
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PatientSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": "-_id", "pagination": null}
Response
{
"data": {
"patientSearch": {
"pageInfo": PageInfo,
"edges": [PatientSchemaEdge]
}
}
}
patientSoaps
Response
Returns [SoapSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
|
media - MediaQueryInputSchema
|
Default = null |
Example
Query
query PatientSoaps(
$patientId: ID!,
$media: MediaQueryInputSchema
) {
patientSoaps(
patientId: $patientId,
media: $media
) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"patientId": "4", "media": null}
Response
{
"data": {
"patientSoaps": [
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": "4",
"techUid": 4,
"appointmentId": 4,
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": "4",
"vetUid": 4,
"voiceNoteId": 4,
"details": "xyz789",
"subjective": "xyz789",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "abc123",
"forms": ["4"],
"voiceNoteApprovedSignature": "abc123"
}
]
}
}
patientStatsReport
Response
Returns a PatientStatsReportSchema!
Arguments
| Name | Description |
|---|---|
filter - ReportQueryFilter
|
Default = null |
Example
Query
query PatientStatsReport($filter: ReportQueryFilter) {
patientStatsReport(filter: $filter) {
speciesTotals {
name
patientCount
}
breedTotals {
name
patientCount
}
genderTotals {
name
patientCount
}
ageGroupTotals {
name
patientCount
}
statusTotals {
name
patientCount
}
patientStatsReportItems {
species
breed
gender
age
status
createdAt
lastInvoiceDate
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"patientStatsReport": {
"speciesTotals": [PatientStatsNamedTotalSchema],
"breedTotals": [PatientStatsNamedTotalSchema],
"genderTotals": [PatientStatsNamedTotalSchema],
"ageGroupTotals": [PatientStatsNamedTotalSchema],
"statusTotals": [PatientStatsNamedTotalSchema],
"patientStatsReportItems": [
PatientStatsReportItemSchema
]
}
}
}
patientVitals
Response
Returns [PatientVitalSchema!]!
Example
Query
query PatientVitals(
$patientId: ID!,
$count: Int
) {
patientVitals(
patientId: $patientId,
count: $count
) {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
}
Variables
{"patientId": 4, "count": null}
Response
{
"data": {
"patientVitals": [
{
"visitNoteId": "4",
"patientVitalId": 4,
"patientId": "4",
"employeeUid": "4",
"soapId": "4",
"surgeryId": "4",
"bcs": 987,
"weightLb": 987.65,
"weightKg": 123.45,
"heartRate": 987,
"tempF": 123.45,
"tempC": 987.65,
"resp": 123,
"bpDia": 123,
"bpSys": 987,
"crt": 123.45,
"painScore": 987,
"periodontalDisease": 987,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
patients
Response
Returns [PatientSchema!]!
Arguments
| Name | Description |
|---|---|
search - String
|
Default = null |
Example
Query
query Patients($search: String) {
patients(search: $search) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"search": null}
Response
{
"data": {
"patients": [
{
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "abc123",
"familyId": "4",
"contactUid": "4",
"firstName": "abc123",
"status": "ACTIVE",
"species": "xyz789",
"lastName": "xyz789",
"breed": "abc123",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": false,
"photoUrl": "xyz789",
"warnings": "xyz789",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
patientsPaginated
Response
Returns a PatientViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - PatientFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query PatientsPaginated(
$filter: PatientFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
patientsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PatientViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"patientsPaginated": {
"pageInfo": PageInfo,
"edges": [PatientViewSchemaEdge]
}
}
}
paymentMethods
Response
Returns a TilledPaymentMethodsSchema!
Arguments
| Name | Description |
|---|---|
clientId - ID!
|
Example
Query
query PaymentMethods($clientId: ID!) {
paymentMethods(clientId: $clientId) {
paymentMethods {
id
chargeable
createdAt
updatedAt
type
achDebit {
...AchDebitSchemaFragment
}
eftDebit {
...EftDebitSchemaFragment
}
billingDetails {
...BillingDetailsSchemaFragment
}
expiresAt
customerId
metadata {
...MetaDataSchemaFragment
}
nickName
card {
...CardSchemaFragment
}
}
total
}
}
Variables
{"clientId": 4}
Response
{
"data": {
"paymentMethods": {
"paymentMethods": [PaymentMethodSchema],
"total": 123
}
}
}
previousVaccine
Response
Returns a VaccineSchema
Example
Query
query PreviousVaccine(
$patientId: ID!,
$treatmentId: ID!
) {
previousVaccine(
patientId: $patientId,
treatmentId: $treatmentId
) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
vaccineId
status
patientId
creatorUid
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
}
Variables
{"patientId": "4", "treatmentId": 4}
Response
{
"data": {
"previousVaccine": {
"media": MediaSchema,
"vaccineId": "4",
"status": "OPEN",
"patientId": "4",
"creatorUid": 4,
"item": VaccineItemSchema,
"approved": true,
"declined": true,
"vaccinationDate": "abc123",
"expDate": "abc123",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"invoiceId": 4,
"clientId": 4,
"tagNumber": "abc123",
"previousTagNumber": "abc123",
"approverId": 4,
"approverName": "xyz789",
"approverLicense": "abc123",
"signature": "xyz789",
"mediaRef": 4,
"originalVaccineId": "4",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
}
}
publicSettings
Response
Returns a PublicSettingsSchema!
Example
Query
query PublicSettings {
publicSettings {
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
dbName
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
twilioPhone
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
street
city
state
country
zipCode
name
email
phone
timezone
clinicLogoMediaId
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
createdAt
updatedAt
maintenanceMode
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"publicSettings": {
"appointmentTypes": [AppointmentTypeSchema],
"dbName": "abc123",
"clinicLogo": MediaSchema,
"twilioPhone": "xyz789",
"featureFlags": [FeatureFlagSchema],
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"country": "abc123",
"zipCode": "xyz789",
"name": "xyz789",
"email": "xyz789",
"phone": "xyz789",
"timezone": "xyz789",
"clinicLogoMediaId": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"maintenanceMode": false,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "abc123"
}
}
}
purchaseOrder
Response
Returns a PurchaseOrderSchema!
Arguments
| Name | Description |
|---|---|
purchaseOrderId - ID!
|
Example
Query
query PurchaseOrder($purchaseOrderId: ID!) {
purchaseOrder(purchaseOrderId: $purchaseOrderId) {
id
vetcoveId
creatorUid
poNumber
subtotal
tax
shipping
total
vendorId
items {
id
name
sku
unitMeasurement
quantity
treatmentId
locationId
vetcoveItemId
unitPrice
listPrice
totalPrice
units
isLinked
packType
availabilityCode
availabilityText
manufacturerName
deletedAt
receivedAt
cancelled
expiredAt
inventoryItemId
lotId
serialNo
ndcNumber
}
orderPlacementTime
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"purchaseOrderId": "4"}
Response
{
"data": {
"purchaseOrder": {
"id": "4",
"vetcoveId": 123,
"creatorUid": 4,
"poNumber": "abc123",
"subtotal": 987,
"tax": 123,
"shipping": 987,
"total": 987,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
purchaseOrders
Response
Returns [PurchaseOrderSchema!]!
Example
Query
query PurchaseOrders {
purchaseOrders {
id
vetcoveId
creatorUid
poNumber
subtotal
tax
shipping
total
vendorId
items {
id
name
sku
unitMeasurement
quantity
treatmentId
locationId
vetcoveItemId
unitPrice
listPrice
totalPrice
units
isLinked
packType
availabilityCode
availabilityText
manufacturerName
deletedAt
receivedAt
cancelled
expiredAt
inventoryItemId
lotId
serialNo
ndcNumber
}
orderPlacementTime
status
deletedAt
createdAt
updatedAt
}
}
Response
{
"data": {
"purchaseOrders": [
{
"id": 4,
"vetcoveId": 987,
"creatorUid": "4",
"poNumber": "abc123",
"subtotal": 987,
"tax": 987,
"shipping": 123,
"total": 123,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
purchaseOrdersPaginated
Response
Returns a PurchaseOrderSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - PurchaseOrderFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query PurchaseOrdersPaginated(
$filter: PurchaseOrderFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
purchaseOrdersPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...PurchaseOrderSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"purchaseOrdersPaginated": {
"pageInfo": PageInfo,
"edges": [PurchaseOrderSchemaEdge]
}
}
}
recentDiagnosesPaginated
Response
Returns a RecentDiagnosisViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - RecentDiagnosisViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query RecentDiagnosesPaginated(
$filter: RecentDiagnosisViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
recentDiagnosesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...RecentDiagnosisViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"recentDiagnosesPaginated": {
"pageInfo": PageInfo,
"edges": [RecentDiagnosisViewSchemaEdge]
}
}
}
reminder
Response
Returns a ReminderSchema!
Arguments
| Name | Description |
|---|---|
reminderId - ID!
|
Example
Query
query Reminder($reminderId: ID!) {
reminder(reminderId: $reminderId) {
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
vaccine {
media {
...MediaSchemaFragment
}
vaccineId
status
patientId
creatorUid
item {
...VaccineItemSchemaFragment
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
isEmailable
isSmsable
reminderId
status
patientId
refId
notes
type
creatorUid
invoiceId
dueDate
createdAt
updatedAt
}
}
Variables
{"reminderId": "4"}
Response
{
"data": {
"reminder": {
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": false,
"isSmsable": true,
"reminderId": 4,
"status": "ACTIVE",
"patientId": "4",
"refId": "4",
"notes": "abc123",
"type": "TREATMENT",
"creatorUid": 4,
"invoiceId": 4,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
reminders
Response
Returns [ReminderSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
|
status - ReminderStatusEnum
|
Default = null |
refId - ID
|
Default = null |
type - ReminderTypeEnum
|
Default = null |
sort - ReminderSortEnum
|
Default = DUE_DATE_ASC |
Example
Query
query Reminders(
$patientId: ID!,
$status: ReminderStatusEnum,
$refId: ID,
$type: ReminderTypeEnum,
$sort: ReminderSortEnum
) {
reminders(
patientId: $patientId,
status: $status,
refId: $refId,
type: $type,
sort: $sort
) {
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
vaccine {
media {
...MediaSchemaFragment
}
vaccineId
status
patientId
creatorUid
item {
...VaccineItemSchemaFragment
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
isEmailable
isSmsable
reminderId
status
patientId
refId
notes
type
creatorUid
invoiceId
dueDate
createdAt
updatedAt
}
}
Variables
{
"patientId": 4,
"status": "null",
"refId": null,
"type": "null",
"sort": "DUE_DATE_ASC"
}
Response
{
"data": {
"reminders": [
{
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": true,
"isSmsable": true,
"reminderId": "4",
"status": "ACTIVE",
"patientId": "4",
"refId": 4,
"notes": "xyz789",
"type": "TREATMENT",
"creatorUid": "4",
"invoiceId": "4",
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
remindersPaginated
Response
Returns a ReminderViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - ReminderViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query RemindersPaginated(
$filter: ReminderViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
remindersPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...ReminderViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"remindersPaginated": {
"pageInfo": PageInfo,
"edges": [ReminderViewSchemaEdge]
}
}
}
revenueReport
Response
Returns a RevenueReportSchema!
Arguments
| Name | Description |
|---|---|
filter - ReportQueryFilter
|
Default = null |
Example
Query
query RevenueReport($filter: ReportQueryFilter) {
revenueReport(filter: $filter) {
providerTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
treatmentTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
typeCodeTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
categoryCodeTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
appointmentTypeTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
monthlyTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
yearlyTotals {
grossRevenue
discount
voidedAmount
netRevenue
qty
name
avgRevenuePerClient
uniqueInvoiceCount
}
revenueReportItems {
invoiceId
grossRevenue
discount
voidedAmount
netRevenue
qty
providerId
treatmentId
treatmentName
providerName
typeCode
type
categoryCode
category
invoicedAt
medicalNoteId
medicalNoteType
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"revenueReport": {
"providerTotals": [NamedTotalSchema],
"treatmentTotals": [NamedTotalSchema],
"typeCodeTotals": [NamedTotalSchema],
"categoryCodeTotals": [NamedTotalSchema],
"appointmentTypeTotals": [NamedTotalSchema],
"monthlyTotals": [NamedTotalSchema],
"yearlyTotals": [NamedTotalSchema],
"revenueReportItems": [RevenueReportItemSchema]
}
}
}
runningLowList
Response
Returns [InventoriesOverviewSchema!]!
Example
Query
query RunningLowList {
runningLowList {
id
isControlledSubstance
isRunningLow
type
pricePerUnit
unit
furthestExpiredAt
quantityRemaining
remainingValue
category
name
createdAt
}
}
Response
{
"data": {
"runningLowList": [
{
"id": "abc123",
"isControlledSubstance": true,
"isRunningLow": false,
"type": "xyz789",
"pricePerUnit": 123,
"unit": "ML",
"furthestExpiredAt": datetime,
"quantityRemaining": Decimal,
"remainingValue": 123,
"category": "abc123",
"name": "xyz789",
"createdAt": datetime
}
]
}
}
rxScript
Response
Returns a RxScriptSchema!
Arguments
| Name | Description |
|---|---|
rxScriptId - ID!
|
Example
Query
query RxScript($rxScriptId: ID!) {
rxScript(rxScriptId: $rxScriptId) {
originalRxScript {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
treatmentobj {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
Variables
{"rxScriptId": 4}
Response
{
"data": {
"rxScript": {
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": "4",
"patientId": "4",
"creatorUid": "4",
"filledById": "4",
"clientId": "4",
"refId": "4",
"originalRefId": "4",
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": 4,
"treatmentInstanceId": 4,
"treatment": "xyz789",
"totalDosage": Decimal,
"duration": 123,
"durationUnit": "MINUTES",
"customDoseUnit": "abc123",
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"refills": 123,
"instructions": "xyz789",
"voided": true,
"voidReason": "xyz789",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
}
}
rxScriptsPaginated
Response
Returns a RxScriptViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - RxScriptFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query RxScriptsPaginated(
$filter: RxScriptFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
rxScriptsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...RxScriptViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"rxScriptsPaginated": {
"pageInfo": PageInfo,
"edges": [RxScriptViewSchemaEdge]
}
}
}
schedule
Response
Returns a ScheduleSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Schedule($id: ID!) {
schedule(id: $id) {
scheduleId
type
creatorUid
employeeUid
startDatetime
endDatetime
fullDay
rrule
onlineBookingConfig {
enabled
appointmentTypesAllowed
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"schedule": {
"scheduleId": 4,
"type": "WORK_HOURS",
"creatorUid": 4,
"employeeUid": 4,
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"rrule": "abc123",
"onlineBookingConfig": OnlineBookingConfigSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
sendFamiliesStatementPdf
Example
Query
query SendFamiliesStatementPdf(
$familyIds: [ID!]!,
$emailMessage: String!
) {
sendFamiliesStatementPdf(
familyIds: $familyIds,
emailMessage: $emailMessage
)
}
Variables
{
"familyIds": ["4"],
"emailMessage": "xyz789"
}
Response
{"data": {"sendFamiliesStatementPdf": true}}
settings
Response
Returns a SettingsSchema!
Example
Query
query Settings {
settings {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"settings": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "xyz789",
"state": "abc123",
"country": "abc123",
"zipCode": "xyz789",
"name": "xyz789",
"status": "OPEN",
"email": "xyz789",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 987,
"vitalsAutolockHours": 123,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": false,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": false,
"clinicIpAddress": "abc123"
}
}
}
smsTemplate
Response
Returns an SMSTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query SmsTemplate($id: ID!) {
smsTemplate(id: $id) {
availableVariables
id
name
description
templateKey
body
type
linkedFormIds
createdAt
updatedAt
deletedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"smsTemplate": {
"availableVariables": {},
"id": "4",
"name": "abc123",
"description": "xyz789",
"templateKey": "abc123",
"body": "xyz789",
"type": "AUTOMATED",
"linkedFormIds": [4],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
}
}
smsTemplates
Response
Returns [SMSTemplateSchema!]!
Arguments
| Name | Description |
|---|---|
filterStandard - Boolean
|
Default = true |
Example
Query
query SmsTemplates($filterStandard: Boolean) {
smsTemplates(filterStandard: $filterStandard) {
availableVariables
id
name
description
templateKey
body
type
linkedFormIds
createdAt
updatedAt
deletedAt
}
}
Variables
{"filterStandard": true}
Response
{
"data": {
"smsTemplates": [
{
"availableVariables": {},
"id": 4,
"name": "xyz789",
"description": "xyz789",
"templateKey": "abc123",
"body": "xyz789",
"type": "AUTOMATED",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
]
}
}
soap
Response
Returns a SoapSchema!
Arguments
| Name | Description |
|---|---|
soapId - ID!
|
|
media - MediaQueryInputSchema
|
Default = null |
Example
Query
query Soap(
$soapId: ID!,
$media: MediaQueryInputSchema
) {
soap(
soapId: $soapId,
media: $media
) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"soapId": 4, "media": null}
Response
{
"data": {
"soap": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": "4",
"creatorUid": "4",
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": "4",
"vetUid": "4",
"voiceNoteId": "4",
"details": "abc123",
"subjective": "abc123",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "xyz789",
"forms": ["4"],
"voiceNoteApprovedSignature": "abc123"
}
}
}
soapInProgress
Response
Returns [SoapViewSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query SoapInProgress($patientId: ID!) {
soapInProgress(patientId: $patientId) {
id
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
status
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
createdAt
appointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
...BaseAppointmentSchemaFragment
}
isEmailable
isSmsable
convertToLocal
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
}
}
Variables
{"patientId": 4}
Response
{
"data": {
"soapInProgress": [
{
"id": "4",
"vet": ClinicUserSchema,
"tech": ClinicUserSchema,
"patientId": 4,
"status": "DRAFT",
"patient": PatientSchema,
"createdAt": datetime,
"appointment": AppointmentSchema,
"appointmentType": AppointmentTypeResolveSchema
}
]
}
}
soapPdf
Response
Returns a MediaSchema!
Example
Query
query SoapPdf(
$soapId: ID!,
$force: Boolean!
) {
soapPdf(
soapId: $soapId,
force: $force
) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"soapId": "4", "force": false}
Response
{
"data": {
"soapPdf": {
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": 4,
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "abc123",
"deletedAt": "abc123",
"title": "xyz789",
"description": "abc123",
"summaryGeneratedByAi": false,
"transcript": "abc123",
"key": "abc123",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
soapTemplate
Response
Returns a SoapTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query SoapTemplate($id: ID!) {
soapTemplate(id: $id) {
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"soapTemplate": {
"appointmentType": AppointmentTypeResolveSchema,
"id": "4",
"creatorId": "4",
"name": "xyz789",
"species": "xyz789",
"appointmentTypeId": "4",
"isDeleted": true,
"favoritedBy": ["4"],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
soapTemplates
Response
Returns [SoapTemplateViewSchema!]!
Arguments
| Name | Description |
|---|---|
filter - SoapTemplateFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query SoapTemplates(
$filter: SoapTemplateFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
soapTemplates(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
appointmentType {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
isFavorite
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"soapTemplates": [
{
"appointmentType": AppointmentTypeSchema,
"id": "4",
"creatorId": "4",
"name": "xyz789",
"species": "xyz789",
"appointmentTypeId": "4",
"isDeleted": true,
"favoritedBy": ["4"],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime,
"creator": ClinicUserSchema,
"isFavorite": true
}
]
}
}
soapTemplatesPaginated
Response
Returns a SoapTemplateViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - SoapTemplateFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query SoapTemplatesPaginated(
$filter: SoapTemplateFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
soapTemplatesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...SoapTemplateViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"soapTemplatesPaginated": {
"pageInfo": PageInfo,
"edges": [SoapTemplateViewSchemaEdge]
}
}
}
soapsPaginated
Response
Returns a SoapViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - SoapViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query SoapsPaginated(
$filter: SoapViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
soapsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...SoapViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"soapsPaginated": {
"pageInfo": PageInfo,
"edges": [SoapViewSchemaEdge]
}
}
}
specialCareNote
Response
Returns a SpecialCareNoteSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query SpecialCareNote($id: ID!) {
specialCareNote(id: $id) {
createdByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
updatedByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
resource {
... on PatientSchema {
...PatientSchemaFragment
}
... on ClinicUserSchema {
...ClinicUserSchemaFragment
}
}
id
resourceId
resourceType
createdBy
updatedBy
note
noteType
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"specialCareNote": {
"createdByUser": ClinicUserSchema,
"updatedByUser": ClinicUserSchema,
"resource": PatientSchema,
"id": 4,
"resourceId": 4,
"resourceType": "PATIENT",
"createdBy": 4,
"updatedBy": 4,
"note": "xyz789",
"noteType": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
specialCareNotesByFilter
Response
Returns [SpecialCareNoteSchema!]!
Arguments
| Name | Description |
|---|---|
filter - SpecialCareNoteFilterSchema
|
Default = null |
includeDeleted - Boolean!
|
Default = false |
Example
Query
query SpecialCareNotesByFilter(
$filter: SpecialCareNoteFilterSchema,
$includeDeleted: Boolean!
) {
specialCareNotesByFilter(
filter: $filter,
includeDeleted: $includeDeleted
) {
createdByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
updatedByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
resource {
... on PatientSchema {
...PatientSchemaFragment
}
... on ClinicUserSchema {
...ClinicUserSchemaFragment
}
}
id
resourceId
resourceType
createdBy
updatedBy
note
noteType
deletedAt
createdAt
updatedAt
}
}
Variables
{"filter": null, "includeDeleted": false}
Response
{
"data": {
"specialCareNotesByFilter": [
{
"createdByUser": ClinicUserSchema,
"updatedByUser": ClinicUserSchema,
"resource": PatientSchema,
"id": 4,
"resourceId": "4",
"resourceType": "PATIENT",
"createdBy": 4,
"updatedBy": 4,
"note": "abc123",
"noteType": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
specialCareNotesByResource
Response
Returns [SpecialCareNoteSchema!]!
Example
Query
query SpecialCareNotesByResource(
$resourceId: ID!,
$resourceType: String!,
$includeDeleted: Boolean!
) {
specialCareNotesByResource(
resourceId: $resourceId,
resourceType: $resourceType,
includeDeleted: $includeDeleted
) {
createdByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
updatedByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
resource {
... on PatientSchema {
...PatientSchemaFragment
}
... on ClinicUserSchema {
...ClinicUserSchemaFragment
}
}
id
resourceId
resourceType
createdBy
updatedBy
note
noteType
deletedAt
createdAt
updatedAt
}
}
Variables
{
"resourceId": 4,
"resourceType": "xyz789",
"includeDeleted": false
}
Response
{
"data": {
"specialCareNotesByResource": [
{
"createdByUser": ClinicUserSchema,
"updatedByUser": ClinicUserSchema,
"resource": PatientSchema,
"id": 4,
"resourceId": "4",
"resourceType": "PATIENT",
"createdBy": "4",
"updatedBy": "4",
"note": "xyz789",
"noteType": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
species
Response
Returns [SpeciesSchema!]!
Example
Query
query Species {
species {
id
species
imageData
createdAt
updatedAt
custom
}
}
Response
{
"data": {
"species": [
{
"id": 4,
"species": "abc123",
"imageData": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"custom": false
}
]
}
}
subscription
Response
Returns a SubscriptionSchema!
Arguments
| Name | Description |
|---|---|
subscriptionId - String!
|
Example
Query
query Subscription($subscriptionId: String!) {
subscription(subscriptionId: $subscriptionId) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"subscriptionId": "abc123"}
Response
{
"data": {
"subscription": {
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "abc123",
"accountId": "abc123",
"customerId": "xyz789",
"status": "ACTIVE",
"price": 123,
"currency": "AUD",
"intervalUnit": "xyz789",
"intervalCount": 987,
"paymentMethodId": "abc123",
"platformFeeAmount": 123,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
}
}
subscriptionPaymentIntents
Response
Returns [PaymentIntentSchema!]!
Arguments
| Name | Description |
|---|---|
subscriptionId - String!
|
Example
Query
query SubscriptionPaymentIntents($subscriptionId: String!) {
subscriptionPaymentIntents(subscriptionId: $subscriptionId) {
billingDetails {
name
}
id
amount
status
updatedAt
customer {
id
accountId
firstName
lastName
createdAt
updatedAt
}
paymentMethod {
card {
...CardPaymentMethodSchemaFragment
}
id
type
createdAt
updatedAt
}
}
}
Variables
{"subscriptionId": "xyz789"}
Response
{
"data": {
"subscriptionPaymentIntents": [
{
"billingDetails": PaymentIntentBillingDetailsSchema,
"id": "abc123",
"amount": 987,
"status": "abc123",
"updatedAt": "abc123",
"customer": PaymentIntentCustomerSchema,
"paymentMethod": PaymentIntentPaymentMethodSchema
}
]
}
}
subscriptions
Response
Returns a SubscriptionsListSchema!
Example
Query
query Subscriptions {
subscriptions {
subscriptions {
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
total
}
}
Response
{
"data": {
"subscriptions": {
"subscriptions": [SubscriptionSchema],
"total": 987
}
}
}
summaryReport
Response
Returns a SummaryReportSchema!
Arguments
| Name | Description |
|---|---|
filter - TransactionQueryFilter
|
Default = null |
Example
Query
query SummaryReport($filter: TransactionQueryFilter) {
summaryReport(filter: $filter) {
categories {
totalsInventoryByAahaCategories {
...TransactionsReportAAHACategoriesFragment
}
totalsShrinkageByAahaCategories {
...TransactionsReportAAHACategoriesFragment
}
}
totalsByTreatment {
treatment {
...InvoiceItemSchemaFragment
}
chargedCount
voidedCount
chargedSubtotal
voidedSubtotal
chargedQuantity
voidedQuantity
}
totalsByEmployee {
employee {
...ClinicUserSchemaFragment
}
chargedTotal
chargesVoidedTotal
treatments {
...TransactionsReportTreatmentsSchemaFragment
}
}
totalsByFamily {
family {
...FamilySchemaFragment
}
chargedTotal
paidTotal
chargesVoidedTotal
paymentsVoidedTotal
}
totalsByGroupDiscount {
groupDiscount {
...GroupDiscountSchemaFragment
}
total
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"summaryReport": {
"categories": CategoryTotalsSchema,
"totalsByTreatment": [
TransactionsReportTreatmentsSchema
],
"totalsByEmployee": [
TransactionsReportEmployeesSchema
],
"totalsByFamily": [TransactionsReportFamilySchema],
"totalsByGroupDiscount": [
TransactionsReportGroupDiscountSchema
]
}
}
}
surgeries
Response
Returns [SurgerySchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query Surgeries($patientId: ID!) {
surgeries(patientId: $patientId) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
procedure
preop {
asaScore
notes
}
intraop {
anesthesiaStartAt
anesthesiaEndAt
procedureStartAt
procedureEndAt
medicationNotes
procedureNotes
}
postop {
numOxygenationMin
isEttExtubated
notes
}
recordedSurgeryVitals {
values {
...SurgeryVitalValueSchemaFragment
}
createdAt
}
}
}
Variables
{"patientId": "4"}
Response
{
"data": {
"surgeries": [
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": 4,
"techUid": 4,
"appointmentId": 4,
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"procedure": "abc123",
"preop": PreopSchema,
"intraop": IntraopSchema,
"postop": PostopSchema,
"recordedSurgeryVitals": [
RecordedSurgeryVitalSchema
]
}
]
}
}
surgeriesPaginated
Response
Returns a SurgeryViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - SurgeryViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query SurgeriesPaginated(
$filter: SurgeryViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
surgeriesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...SurgeryViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"surgeriesPaginated": {
"pageInfo": PageInfo,
"edges": [SurgeryViewSchemaEdge]
}
}
}
surgery
Response
Returns a SurgerySchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Surgery($id: ID!) {
surgery(id: $id) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
procedure
preop {
asaScore
notes
}
intraop {
anesthesiaStartAt
anesthesiaEndAt
procedureStartAt
procedureEndAt
medicationNotes
procedureNotes
}
postop {
numOxygenationMin
isEttExtubated
notes
}
recordedSurgeryVitals {
values {
...SurgeryVitalValueSchemaFragment
}
createdAt
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"surgery": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": 4,
"creatorUid": 4,
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"procedure": "abc123",
"preop": PreopSchema,
"intraop": IntraopSchema,
"postop": PostopSchema,
"recordedSurgeryVitals": [
RecordedSurgeryVitalSchema
]
}
}
}
surgeryTemplate
Response
Returns a SurgeryTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query SurgeryTemplate($id: ID!) {
surgeryTemplate(id: $id) {
id
name
creatorId
species
isDeleted
favoritedBy
surgeryTemplateData {
treatments {
...TreatmentSchemaFragment
}
procedure
preopNotes
intraopMedicationNotes
intraopProcedureNotes
postopNotes
treatmentIds
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"surgeryTemplate": {
"id": "4",
"name": "abc123",
"creatorId": 4,
"species": "xyz789",
"isDeleted": false,
"favoritedBy": [4],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
surgeryTemplates
Response
Returns a SurgeryTemplateViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - SurgeryTemplateFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query SurgeryTemplates(
$filter: SurgeryTemplateFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
surgeryTemplates(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...SurgeryTemplateViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"surgeryTemplates": {
"pageInfo": PageInfo,
"edges": [SurgeryTemplateViewSchemaEdge]
}
}
}
surgeryVitals
Response
Returns [SurgeryVitalSchema!]!
Example
Query
query SurgeryVitals {
surgeryVitals {
id
name
order
}
}
Response
{
"data": {
"surgeryVitals": [
{
"id": 4,
"name": "xyz789",
"order": 123
}
]
}
}
task
Response
Returns a TaskSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Task($id: ID!) {
task(id: $id) {
id
patientId
clientId
creatorId
assignedById
assigneeId
taskType
priority
status
description
dueAt
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"task": {
"id": 4,
"patientId": 4,
"clientId": "4",
"creatorId": 4,
"assignedById": "4",
"assigneeId": "4",
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "xyz789",
"dueAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
tasksPaginated
Response
Returns a TaskViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - TaskViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query TasksPaginated(
$filter: TaskViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
tasksPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...TaskViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"tasksPaginated": {
"pageInfo": PageInfo,
"edges": [TaskViewSchemaEdge]
}
}
}
taxRateForClient
terminals
Response
Returns a TilledTerminalsSchema!
Example
Query
query Terminals {
terminals {
terminals {
id
accountId
type
serialNumber
description
createdAt
updatedAt
}
}
}
Response
{
"data": {
"terminals": {"terminals": [TerminalReaderSchema]}
}
}
tilledInfo
Response
Returns a TilledInfoSchema!
Example
Query
query TilledInfo {
tilledInfo {
bankAccounts {
defaultForCurrency
updatedAt
createdAt
id
routingNumber
accountId
last4
accountHolderName
bankName
type
currency
status
}
type
}
}
Response
{
"data": {
"tilledInfo": {
"bankAccounts": [BankAccountSchema],
"type": "xyz789"
}
}
}
transaction
Response
Returns a TransactionSchema!
Arguments
| Name | Description |
|---|---|
transactionId - ID!
|
Example
Query
query Transaction($transactionId: ID!) {
transaction(transactionId: $transactionId) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"transactionId": "4"}
Response
{
"data": {
"transaction": {
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": 4,
"familyId": "4",
"clientId": "4",
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 987,
"invoiceId": 4,
"voidedTransactionId": "4",
"otherInvoiceIds": ["4"],
"otherTransactionIds": [4],
"partialVoid": true,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": false
}
}
}
transactions
Response
Returns a TransactionSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - TransactionQueryFilter
|
Default = null |
sort - String
|
Default = "-_id" |
pagination - PaginationFilter
|
Default = null |
Example
Query
query Transactions(
$filter: TransactionQueryFilter,
$sort: String,
$pagination: PaginationFilter
) {
transactions(
filter: $filter,
sort: $sort,
pagination: $pagination
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...TransactionSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": "-_id", "pagination": null}
Response
{
"data": {
"transactions": {
"pageInfo": PageInfo,
"edges": [TransactionSchemaEdge]
}
}
}
transactionsForReport
Response
Returns [TransactionSchema!]!
Arguments
| Name | Description |
|---|---|
filter - ReportQueryFilter!
|
Example
Query
query TransactionsForReport($filter: ReportQueryFilter!) {
transactionsForReport(filter: $filter) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"filter": ReportQueryFilter}
Response
{
"data": {
"transactionsForReport": [
{
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": 4,
"familyId": 4,
"clientId": 4,
"creatorUid": "4",
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": 4,
"voidedTransactionId": "4",
"otherInvoiceIds": [4],
"otherTransactionIds": [4],
"partialVoid": true,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": false
}
]
}
}
transactionsPaginated
Response
Returns a TransactionViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - TransactionFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query TransactionsPaginated(
$filter: TransactionFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
transactionsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...TransactionViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"transactionsPaginated": {
"pageInfo": PageInfo,
"edges": [TransactionViewSchemaEdge]
}
}
}
transactionsReport
Response
Returns a TransactionsReportSchema!
Arguments
| Name | Description |
|---|---|
filter - TransactionQueryFilter
|
Default = null |
Example
Query
query TransactionsReport($filter: TransactionQueryFilter) {
transactionsReport(filter: $filter) {
invoices {
chargedSubtotal
chargedFees
chargedDiscounts
chargedTaxes
chargedPstTaxes
chargedTotal
voidedTotal
netTotal
netInterestCharged
}
payments {
paidTotal
paymentVoidedTotal
cashReconciliationTotal
netTotal
totalsByPaymentMethod {
...TransactionsReportPaymentMethodsSchemaFragment
}
totalsByCreditCardNetwork {
...TransactionsReportPaymentMethodsSchemaFragment
}
totalsByNectarpay {
...TransactionsReportPaymentMethodsSchemaFragment
}
totalsByAahaCategories {
...TransactionsReportAAHACategoriesFragment
}
transactionsByPaymentMethods {
...TransactionByPaymentMethodSchemaFragment
}
}
accountsReceivable {
invoiced
payments
netReceivable
storeCreditsIssued
receivablesTransactions {
...TransactionViewSchemaFragment
}
}
}
}
Variables
{"filter": null}
Response
{
"data": {
"transactionsReport": {
"invoices": TransactionsReportInvoicesSchema,
"payments": TransactionsReportPaymentsSchema,
"accountsReceivable": TransactionsReportTotalSchema
}
}
}
treatment
Response
Returns a TreatmentSchema!
Arguments
| Name | Description |
|---|---|
treatmentId - ID!
|
Example
Query
query Treatment($treatmentId: ID!) {
treatment(treatmentId: $treatmentId) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
treatmentId
relativeDueTime
}
satisfyReminders {
treatmentId
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
rate
threshold
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
treatmentId
quantity
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
}
Variables
{"treatmentId": 4}
Response
{
"data": {
"treatment": {
"dischargeDocuments": [DischargeDocumentSchema],
"treatmentId": 4,
"name": "xyz789",
"unit": "ML",
"pricePerUnit": 987,
"instructions": "abc123",
"adminFee": 987,
"minimumCharge": 123,
"customDoseUnit": "abc123",
"duration": 987,
"durUnit": "MINUTES",
"refills": 123,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"dischargeDocumentIds": [4],
"type": "xyz789",
"typeCode": "xyz789",
"category": "abc123",
"categoryCode": "abc123",
"subCategory": "abc123",
"subCategoryCode": "xyz789",
"isTaxable": true,
"isPstTaxable": false,
"isDiscountable": true,
"isControlledSubstance": false,
"generateReminders": [
TreatmentReminderGenerateSchema
],
"satisfyReminders": [
TreatmentReminderSatisfySchema
],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"deactivatePatientOnCheckout": false,
"spayPatientOnCheckout": true,
"useHistoricalHigh": false,
"discountRates": [DiscountRateSchema],
"isProvisional": false,
"useAsDefaultNoProvisional": true,
"labCat": "IN_HOUSE",
"labCode": "xyz789",
"labDevice": "xyz789",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "abc123",
"inventoryEnabled": false,
"inventoryTreatmentId": "4",
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": true,
"compoundInventoryItems": [
CompoundInventoryItemSchema
],
"vetcoveEnabled": true,
"minimumQuantity": Decimal,
"quantityRemaining": Decimal,
"furthestExpiredAt": "abc123",
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 123,
"clinicCostPerUnit": 987,
"useVendorCost": false,
"vendorListPrice": 123,
"route": "ORAL",
"freq": "xyz789",
"manufacturer": "abc123",
"vaccine": "xyz789",
"lotNo": "abc123",
"expDate": datetime,
"species": "abc123",
"dose": Decimal
}
}
}
treatmentCategories
Response
Returns [TreatmentTypeSchema!]!
Example
Query
query TreatmentCategories {
treatmentCategories {
type
typeCode
locked
categories {
category
categoryCode
locked
subCategories {
...TreatmentSubCategorySchemaFragment
}
}
}
}
Response
{
"data": {
"treatmentCategories": [
{
"type": "xyz789",
"typeCode": "xyz789",
"locked": false,
"categories": [TreatmentCategorySchema]
}
]
}
}
treatmentPlan
Response
Returns a TreatmentPlanViewSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query TreatmentPlan($id: ID!) {
treatmentPlan(id: $id) {
id
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"treatmentPlan": {
"id": "xyz789",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"patientId": 4,
"clientId": "4",
"providerId": 4,
"techUid": "4",
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
treatmentPlans
Response
Returns [TreatmentPlanViewSchema!]!
Arguments
| Name | Description |
|---|---|
filter - TreatmentPlanViewFilterSchema
|
Default = null |
Example
Query
query TreatmentPlans($filter: TreatmentPlanViewFilterSchema) {
treatmentPlans(filter: $filter) {
id
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"filter": null}
Response
{
"data": {
"treatmentPlans": [
{
"id": "abc123",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"patientId": 4,
"clientId": 4,
"providerId": 4,
"techUid": 4,
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": 4,
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
treatmentReminderCount
treatments
Response
Returns [TreatmentSchema!]!
Example
Query
query Treatments(
$type: String,
$updatedAfter: datetime
) {
treatments(
type: $type,
updatedAfter: $updatedAfter
) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
treatmentId
relativeDueTime
}
satisfyReminders {
treatmentId
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
rate
threshold
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
treatmentId
quantity
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
}
Variables
{"type": null, "updatedAfter": null}
Response
{
"data": {
"treatments": [
{
"dischargeDocuments": [DischargeDocumentSchema],
"treatmentId": 4,
"name": "abc123",
"unit": "ML",
"pricePerUnit": 987,
"instructions": "xyz789",
"adminFee": 987,
"minimumCharge": 123,
"customDoseUnit": "abc123",
"duration": 987,
"durUnit": "MINUTES",
"refills": 987,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"dischargeDocumentIds": [4],
"type": "abc123",
"typeCode": "abc123",
"category": "xyz789",
"categoryCode": "xyz789",
"subCategory": "xyz789",
"subCategoryCode": "xyz789",
"isTaxable": false,
"isPstTaxable": false,
"isDiscountable": true,
"isControlledSubstance": false,
"generateReminders": [
TreatmentReminderGenerateSchema
],
"satisfyReminders": [
TreatmentReminderSatisfySchema
],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"deactivatePatientOnCheckout": true,
"spayPatientOnCheckout": false,
"useHistoricalHigh": false,
"discountRates": [DiscountRateSchema],
"isProvisional": false,
"useAsDefaultNoProvisional": false,
"labCat": "IN_HOUSE",
"labCode": "xyz789",
"labDevice": "abc123",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "xyz789",
"inventoryEnabled": false,
"inventoryTreatmentId": "4",
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": true,
"compoundInventoryItems": [
CompoundInventoryItemSchema
],
"vetcoveEnabled": true,
"minimumQuantity": Decimal,
"quantityRemaining": Decimal,
"furthestExpiredAt": "xyz789",
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 123,
"clinicCostPerUnit": 987,
"useVendorCost": true,
"vendorListPrice": 987,
"route": "ORAL",
"freq": "abc123",
"manufacturer": "xyz789",
"vaccine": "abc123",
"lotNo": "abc123",
"expDate": datetime,
"species": "xyz789",
"dose": Decimal
}
]
}
}
treatmentsPaginated
Response
Returns a TreatmentSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - TreatmentQueryFilter
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query TreatmentsPaginated(
$filter: TreatmentQueryFilter,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
treatmentsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...TreatmentSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"treatmentsPaginated": {
"pageInfo": PageInfo,
"edges": [TreatmentSchemaEdge]
}
}
}
unifiedSearch
Response
Returns a UnifiedSearchResponseSchema!
Arguments
| Name | Description |
|---|---|
searchTerm - String!
|
|
limit - Int!
|
Default = 10 |
filter - UnifiedSearchFilter
|
Default = null |
Example
Query
query UnifiedSearch(
$searchTerm: String!,
$limit: Int!,
$filter: UnifiedSearchFilter
) {
unifiedSearch(
searchTerm: $searchTerm,
limit: $limit,
filter: $filter
) {
patientResults {
node {
...PatientSchemaFragment
}
highlights {
...HighlightSchemaFragment
}
score
}
clientResults {
node {
...ClinicUserSchemaFragment
}
highlights {
...HighlightSchemaFragment
}
score
}
treatmentResults {
node {
...TreatmentSchemaFragment
}
highlights {
...HighlightSchemaFragment
}
score
}
bundleResults {
node {
...BundleSchemaFragment
}
highlights {
...HighlightSchemaFragment
}
score
}
metadata {
totalCount
patientCount
clientCount
treatmentCount
bundleCount
}
}
}
Variables
{
"searchTerm": "xyz789",
"limit": 10,
"filter": null
}
Response
{
"data": {
"unifiedSearch": {
"patientResults": [PatientSearchResultSchema],
"clientResults": [ClientSearchResultSchema],
"treatmentResults": [TreatmentSearchResultSchema],
"bundleResults": [BundleSearchResultSchema],
"metadata": UnifiedSearchMetadataSchema
}
}
}
upcomingAppointmentDate
userClient
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
userId - ID!
|
Example
Query
query UserClient($userId: ID!) {
userClient(userId: $userId) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"userId": "4"}
Response
{
"data": {
"userClient": {
"profilePicture": MediaSchema,
"id": "4",
"firstName": "abc123",
"lastName": "xyz789",
"emailH": "xyz789",
"emailW": "xyz789",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": false,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
usersCommission
Response
Returns a UsersCommissionSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query UsersCommission($id: ID!) {
usersCommission(id: $id) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
userId
invoiceId
treatmentId
revenue
commissionRate
commissionAmount
deletedAt
createdAt
updatedAt
voidedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"usersCommission": {
"treatment": TreatmentSchema,
"id": "4",
"userId": "4",
"invoiceId": "4",
"treatmentId": 4,
"revenue": 987,
"commissionRate": 987.65,
"commissionAmount": 987,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"voidedAt": datetime
}
}
}
usersCommissionReport
Response
Returns [UsersCommissionViewSchema!]!
Arguments
| Name | Description |
|---|---|
filter - UsersCommissionViewFilterSchema
|
Default = null |
Example
Query
query UsersCommissionReport($filter: UsersCommissionViewFilterSchema) {
usersCommissionReport(filter: $filter) {
id
userId
user {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoiceId
invoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
treatmentId
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
revenue
commissionRate
commissionAmount
deletedAt
createdAt
updatedAt
voidedAt
}
}
Variables
{"filter": null}
Response
{
"data": {
"usersCommissionReport": [
{
"id": 4,
"userId": "4",
"user": ClinicUserSchema,
"invoiceId": "4",
"invoice": InvoiceSchema,
"treatmentId": 4,
"treatment": TreatmentSchema,
"revenue": 987,
"commissionRate": 123.45,
"commissionAmount": 123,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"voidedAt": datetime
}
]
}
}
usersCommissionReportPaginated
Response
Returns a UsersCommissionViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - UsersCommissionViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query UsersCommissionReportPaginated(
$filter: UsersCommissionViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
usersCommissionReportPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...UsersCommissionViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"usersCommissionReportPaginated": {
"pageInfo": PageInfo,
"edges": [UsersCommissionViewSchemaEdge]
}
}
}
usersWithCommissionSettings
Response
Returns [ClinicUserSchema!]!
Example
Query
query UsersWithCommissionSettings {
usersWithCommissionSettings {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Response
{
"data": {
"usersWithCommissionSettings": [
{
"profilePicture": MediaSchema,
"id": "4",
"firstName": "abc123",
"lastName": "xyz789",
"emailH": "xyz789",
"emailW": "abc123",
"phoneH": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": true,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
vaccine
Response
Returns a VaccineSchema!
Arguments
| Name | Description |
|---|---|
vaccineId - ID!
|
Example
Query
query Vaccine($vaccineId: ID!) {
vaccine(vaccineId: $vaccineId) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
vaccineId
status
patientId
creatorUid
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
}
Variables
{"vaccineId": 4}
Response
{
"data": {
"vaccine": {
"media": MediaSchema,
"vaccineId": 4,
"status": "OPEN",
"patientId": 4,
"creatorUid": 4,
"item": VaccineItemSchema,
"approved": false,
"declined": false,
"vaccinationDate": "xyz789",
"expDate": "abc123",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"invoiceId": "4",
"clientId": 4,
"tagNumber": "xyz789",
"previousTagNumber": "xyz789",
"approverId": 4,
"approverName": "xyz789",
"approverLicense": "abc123",
"signature": "abc123",
"mediaRef": "4",
"originalVaccineId": "4",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
vaccinePdf
Response
Returns a VaccineViewSchema
Arguments
| Name | Description |
|---|---|
vaccineId - ID!
|
Example
Query
query VaccinePdf($vaccineId: ID!) {
vaccinePdf(vaccineId: $vaccineId) {
id
patientId
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
createdAt
updatedAt
status
creatorUid
clientId
treatmentId
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
vaccineId
instanceId
approverId
tagNumber
previousTagNumber
approverName
approverLicense
approved
declined
vaccinationDate
expDate
mediaRef
originalVaccineId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
approver {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
lotNo
serialNo
patientFirstNameLowercase
clientLastNameLowercase
approverLastNameLowercase
}
}
Variables
{"vaccineId": 4}
Response
{
"data": {
"vaccinePdf": {
"id": 4,
"patientId": "4",
"item": VaccineItemSchema,
"createdAt": datetime,
"updatedAt": datetime,
"status": "OPEN",
"creatorUid": "4",
"clientId": "4",
"treatmentId": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"invoiceId": "4",
"vaccineId": 4,
"instanceId": 4,
"approverId": 4,
"tagNumber": "abc123",
"previousTagNumber": "abc123",
"approverName": "xyz789",
"approverLicense": "xyz789",
"approved": false,
"declined": false,
"vaccinationDate": datetime,
"expDate": datetime,
"mediaRef": "4",
"originalVaccineId": 4,
"patient": PatientSchema,
"media": MediaSchema,
"soap": SoapSchema,
"approver": ClinicUserSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"lotNo": "abc123",
"serialNo": "xyz789",
"patientFirstNameLowercase": "abc123",
"clientLastNameLowercase": "xyz789",
"approverLastNameLowercase": "xyz789"
}
}
}
vaccinesPaginated
Response
Returns a VaccineViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - VaccineFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query VaccinesPaginated(
$filter: VaccineFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
vaccinesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...VaccineViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"vaccinesPaginated": {
"pageInfo": PageInfo,
"edges": [VaccineViewSchemaEdge]
}
}
}
vendors
Response
Returns [VendorSchema!]!
Example
Query
query Vendors {
vendors {
id
name
contactName
contactEmail
vetcoveId
type
accountNumber
website
deletedAt
}
}
Response
{
"data": {
"vendors": [
{
"id": 4,
"name": "abc123",
"contactName": "xyz789",
"contactEmail": "xyz789",
"vetcoveId": 987,
"type": "MANUFACTURER",
"accountNumber": "abc123",
"website": "xyz789",
"deletedAt": datetime
}
]
}
}
vendorsPaginated
Response
Returns a VendorSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - VendorFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query VendorsPaginated(
$filter: VendorFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
vendorsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...VendorSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"vendorsPaginated": {
"pageInfo": PageInfo,
"edges": [VendorSchemaEdge]
}
}
}
vetcoveClinicInfo
Response
Returns a VetcoveClinicInfoSchema
Example
Query
query VetcoveClinicInfo {
vetcoveClinicInfo {
vetcoveId
name
id
}
}
Response
{
"data": {
"vetcoveClinicInfo": {
"vetcoveId": 987,
"name": "abc123",
"id": "xyz789"
}
}
}
viewer
Response
Returns a ClinicUserSchema!
Example
Query
query Viewer {
viewer {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Response
{
"data": {
"viewer": {
"profilePicture": MediaSchema,
"id": "4",
"firstName": "xyz789",
"lastName": "xyz789",
"emailH": "xyz789",
"emailW": "xyz789",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": false,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
visitNote
Response
Returns a VisitNoteSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query VisitNote($id: ID!) {
visitNote(id: $id) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
voiceNoteId
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"visitNote": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": 4,
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"voiceNoteId": "4",
"notes": "xyz789",
"details": "abc123",
"recs": "xyz789",
"assessment": SoapAssessmentSchema
}
}
}
visitNotePdf
Response
Returns a MediaSchema!
Example
Query
query VisitNotePdf(
$id: ID!,
$force: Boolean!
) {
visitNotePdf(
id: $id,
force: $force
) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"id": 4, "force": false}
Response
{
"data": {
"visitNotePdf": {
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "xyz789",
"visitNote": VisitNoteSchema,
"id": 4,
"resourceId": 4,
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "xyz789",
"deletedAt": "abc123",
"title": "xyz789",
"description": "abc123",
"summaryGeneratedByAi": false,
"transcript": "xyz789",
"key": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
visitNoteTemplate
Response
Returns a VisitNoteTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query VisitNoteTemplate($id: ID!) {
visitNoteTemplate(id: $id) {
id
name
creatorId
species
isDeleted
favoritedBy
appointmentTypeId
visitNoteTemplateData {
treatments {
...TreatmentSchemaFragment
}
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
}
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"visitNoteTemplate": {
"id": 4,
"name": "abc123",
"creatorId": "4",
"species": "xyz789",
"isDeleted": false,
"favoritedBy": [4],
"appointmentTypeId": 4,
"visitNoteTemplateData": VisitNoteTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
visitNoteTemplatesPaginated
Response
Returns a VisitNoteTemplateSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - VisitNoteTemplateFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query VisitNoteTemplatesPaginated(
$filter: VisitNoteTemplateFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
visitNoteTemplatesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...VisitNoteTemplateSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"visitNoteTemplatesPaginated": {
"pageInfo": PageInfo,
"edges": [VisitNoteTemplateSchemaEdge]
}
}
}
visitNotes
Response
Returns [VisitNoteSchema!]!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
Example
Query
query VisitNotes($patientId: ID!) {
visitNotes(patientId: $patientId) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
voiceNoteId
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
}
}
Variables
{"patientId": 4}
Response
{
"data": {
"visitNotes": [
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"voiceNoteId": 4,
"notes": "xyz789",
"details": "abc123",
"recs": "abc123",
"assessment": SoapAssessmentSchema
}
]
}
}
visitNotesPaginated
Response
Returns a VisitNoteViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - VisitNoteViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query VisitNotesPaginated(
$filter: VisitNoteViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
visitNotesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...VisitNoteViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"visitNotesPaginated": {
"pageInfo": PageInfo,
"edges": [VisitNoteViewSchemaEdge]
}
}
}
voiceNote
Response
Returns a VoiceNoteSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query VoiceNote($id: ID!) {
voiceNote(id: $id) {
creatorId
id
soapId
patientId
convertedSoapNote
recordings {
mimeType
mediaUrl
transcribedText
mediaId
createdAt
}
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"voiceNote": {
"creatorId": "4",
"id": 4,
"soapId": "4",
"patientId": "4",
"convertedSoapNote": "xyz789",
"recordings": [RecordingSchema],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
voiceNotesPaginated
Response
Returns a VoiceNoteViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - VoiceNoteViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query VoiceNotesPaginated(
$filter: VoiceNoteViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
voiceNotesPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...VoiceNoteViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"voiceNotesPaginated": {
"pageInfo": PageInfo,
"edges": [VoiceNoteViewSchemaEdge]
}
}
}
voidedTransactions
Response
Returns [TransactionSchema!]!
Arguments
| Name | Description |
|---|---|
transactionId - ID!
|
Example
Query
query VoidedTransactions($transactionId: ID!) {
voidedTransactions(transactionId: $transactionId) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"transactionId": "4"}
Response
{
"data": {
"voidedTransactions": [
{
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": 4,
"familyId": "4",
"clientId": 4,
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 987,
"invoiceId": "4",
"voidedTransactionId": 4,
"otherInvoiceIds": ["4"],
"otherTransactionIds": ["4"],
"partialVoid": true,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": true
}
]
}
}
workflowAutomation
Response
Returns a WorkflowAutomation
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query WorkflowAutomation($id: String!) {
workflowAutomation(id: $id) {
pendingExecutionsCount
id
name
description
status
createdBy
clinicId
triggers {
type
operator
conditions {
...WorkflowAutomationConditionsFragment
}
}
triggerLogic
actions {
type
timing {
...ActionTimingFragment
}
config {
...WorkflowAutomationActionConfigFragment
}
}
instanceId
createdAt
updatedAt
updatedBy
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"workflowAutomation": {
"pendingExecutionsCount": 123,
"id": "4",
"name": "abc123",
"description": "abc123",
"status": "ACTIVE",
"createdBy": "4",
"clinicId": "4",
"triggers": [WorkflowAutomationTrigger],
"triggerLogic": "AND",
"actions": [WorkflowAutomationAction],
"instanceId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"updatedBy": 4
}
}
}
workflowAutomationOptions
Response
Returns a WorkflowAutomationOptions!
Example
Query
query WorkflowAutomationOptions {
workflowAutomationOptions {
triggers {
id
name
operators
fieldOptions {
...WorkflowAutomationFieldOptionFragment
}
eventType
}
actions {
name
methods
timingOptions
timingConfig {
...WorkflowAutomationTimingConfigFragment
}
requiresTemplate
}
operators
}
}
Response
{
"data": {
"workflowAutomationOptions": {
"triggers": [WorkflowAutomationTriggerOption],
"actions": [WorkflowAutomationActionOption],
"operators": ["abc123"]
}
}
}
workflowAutomationsPaginated
Response
Returns a WorkflowAutomationViewConnection!
Arguments
| Name | Description |
|---|---|
filter - WorkflowAutomationViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query WorkflowAutomationsPaginated(
$filter: WorkflowAutomationViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
workflowAutomationsPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...WorkflowAutomationViewFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"workflowAutomationsPaginated": {
"pageInfo": PageInfo,
"edges": [WorkflowAutomationViewEdge]
}
}
}
writtenRxScripts
Response
Returns [RxScriptViewSchema!]!
Arguments
| Name | Description |
|---|---|
invoiceId - ID!
|
Example
Query
query WrittenRxScripts($invoiceId: ID!) {
writtenRxScripts(invoiceId: $invoiceId) {
id
rxScriptId
patientId
clientId
totalDosage
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
beginsAt
expiresAt
refills
duration
voided
treatment
createdAt
updatedAt
instructions
creatorUid
filledById
refId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientFirstNameLowercase
clientLastNameLowercase
originalRefId
renewedRefId
renewedFromRefId
treatmentId
providerLastNameLowercase
originalRxScript {
originalRxScript {
...RxScriptOriginalSchemaFragment
}
mostRecentRefill {
...RxScriptOriginalSchemaFragment
}
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
originalRxScript {
...RxScriptOriginalSchemaFragment
}
mostRecentRefill {
...RxScriptOriginalSchemaFragment
}
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
}
Variables
{"invoiceId": "4"}
Response
{
"data": {
"writtenRxScripts": [
{
"id": "4",
"rxScriptId": "4",
"patientId": 4,
"clientId": "4",
"totalDosage": Decimal,
"durationUnit": "abc123",
"customDoseUnit": "abc123",
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"beginsAt": datetime,
"expiresAt": datetime,
"refills": 123,
"duration": 123,
"voided": false,
"treatment": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"instructions": "abc123",
"creatorUid": 4,
"filledById": "4",
"refId": 4,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"patientFirstNameLowercase": "xyz789",
"clientLastNameLowercase": "abc123",
"originalRefId": "4",
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": "4",
"providerLastNameLowercase": "xyz789",
"originalRxScript": RxScriptSchema,
"mostRecentRefill": RxScriptSchema
}
]
}
}
xray
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query Xray($id: ID!) {
xray(id: $id) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"xray": {
"resultUrl": "xyz789",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": "4",
"treatmentId": "4",
"patientId": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"isStaff": false,
"providerId": 4,
"status": "NEW",
"notes": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
xrayModalities
Response
Returns [XrayModalitySchema!]!
Arguments
| Name | Description |
|---|---|
vendor - XrayVendor!
|
Example
Query
query XrayModalities($vendor: XrayVendor!) {
xrayModalities(vendor: $vendor) {
locationToken
modalityTypeCode
}
}
Variables
{"vendor": "OTHER"}
Response
{
"data": {
"xrayModalities": [
{
"locationToken": "abc123",
"modalityTypeCode": "abc123"
}
]
}
}
xraysPaginated
Response
Returns a XrayViewSchemaConnection!
Arguments
| Name | Description |
|---|---|
filter - XrayViewFilterSchema
|
Default = null |
sort - [Sorter!]
|
Default = null |
paginationInfo - PaginationInfo
|
Default = null |
Example
Query
query XraysPaginated(
$filter: XrayViewFilterSchema,
$sort: [Sorter!],
$paginationInfo: PaginationInfo
) {
xraysPaginated(
filter: $filter,
sort: $sort,
paginationInfo: $paginationInfo
) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
page
count
}
edges {
node {
...XrayViewSchemaFragment
}
cursor
}
}
}
Variables
{"filter": null, "sort": null, "paginationInfo": null}
Response
{
"data": {
"xraysPaginated": {
"pageInfo": PageInfo,
"edges": [XrayViewSchemaEdge]
}
}
}
Mutations
acceptPurchaseOrderItem
Response
Returns an InventoryItemSchema!
Arguments
| Name | Description |
|---|---|
input - InventoryItemFromPurchaseOrderCreateSchema!
|
Example
Query
mutation AcceptPurchaseOrderItem($input: InventoryItemFromPurchaseOrderCreateSchema!) {
acceptPurchaseOrderItem(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
unitCost
totalCost
sku
uom
inventoryQuantities {
vendorId
locationId
quantityOnHand
sellRatio
createdAt
updatedAt
}
inventoryLot {
lotId
manufacturer
serialNo
ndcNumber
quantityReceived
quantityRemaining
expiredAt
receivedAt
manufacturedAt
deletedAt
createdAt
updatedAt
}
treatmentId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": InventoryItemFromPurchaseOrderCreateSchema}
Response
{
"data": {
"acceptPurchaseOrderItem": {
"treatment": TreatmentSchema,
"id": 4,
"unitCost": 987,
"totalCost": 987,
"sku": "xyz789",
"uom": "abc123",
"inventoryQuantities": [InventoryQuantitySchema],
"inventoryLot": InventoryLotSchema,
"treatmentId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addAppointment
Response
Returns an AppointmentSchema!
Arguments
| Name | Description |
|---|---|
input - AppointmentCreateSchema!
|
Example
Query
mutation AddAppointment($input: AppointmentCreateSchema!) {
addAppointment(input: $input) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{"input": AppointmentCreateSchema}
Response
{
"data": {
"addAppointment": {
"appointmentId": 4,
"assignedUid": "4",
"creatorUid": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": "4",
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": false,
"isRecurring": false,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": true,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": false,
"convertToLocal": true
}
}
}
addChatSession
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
input - PatientAddChatSessionSchema!
|
Example
Query
mutation AddChatSession($input: PatientAddChatSessionSchema!) {
addChatSession(input: $input) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"input": PatientAddChatSessionSchema}
Response
{
"data": {
"addChatSession": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "xyz789",
"familyId": "4",
"contactUid": "4",
"firstName": "xyz789",
"status": "ACTIVE",
"species": "xyz789",
"lastName": "xyz789",
"breed": "xyz789",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 123.45,
"weightKg": 987.65,
"gender": "MALE",
"spayNeuter": true,
"photoUrl": "xyz789",
"warnings": "abc123",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addClient
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
input - ClientCreateSchema!
|
Example
Query
mutation AddClient($input: ClientCreateSchema!) {
addClient(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": ClientCreateSchema}
Response
{
"data": {
"addClient": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
addClinicEmployeeSchedule
Response
Returns a ScheduleSchema!
Arguments
| Name | Description |
|---|---|
employeeUid - ID!
|
|
type - ScheduleType!
|
|
startDatetime - datetime!
|
|
endDatetime - datetime!
|
|
creatorUid - ID!
|
|
fullDay - Boolean!
|
|
rrule - String!
|
|
onlineBookingConfig - OnlineBookingConfigUpdateSchema
|
Default = null |
Example
Query
mutation AddClinicEmployeeSchedule(
$employeeUid: ID!,
$type: ScheduleType!,
$startDatetime: datetime!,
$endDatetime: datetime!,
$creatorUid: ID!,
$fullDay: Boolean!,
$rrule: String!,
$onlineBookingConfig: OnlineBookingConfigUpdateSchema
) {
addClinicEmployeeSchedule(
employeeUid: $employeeUid,
type: $type,
startDatetime: $startDatetime,
endDatetime: $endDatetime,
creatorUid: $creatorUid,
fullDay: $fullDay,
rrule: $rrule,
onlineBookingConfig: $onlineBookingConfig
) {
scheduleId
type
creatorUid
employeeUid
startDatetime
endDatetime
fullDay
rrule
onlineBookingConfig {
enabled
appointmentTypesAllowed
}
createdAt
updatedAt
}
}
Variables
{
"employeeUid": "4",
"type": "WORK_HOURS",
"startDatetime": datetime,
"endDatetime": datetime,
"creatorUid": "4",
"fullDay": true,
"rrule": "abc123",
"onlineBookingConfig": null
}
Response
{
"data": {
"addClinicEmployeeSchedule": {
"scheduleId": "4",
"type": "WORK_HOURS",
"creatorUid": 4,
"employeeUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": false,
"rrule": "xyz789",
"onlineBookingConfig": OnlineBookingConfigSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addCommunication
Response
Returns a CommunicationSchema!
Arguments
| Name | Description |
|---|---|
input - CommunicationCreateSchema!
|
Example
Query
mutation AddCommunication($input: CommunicationCreateSchema!) {
addCommunication(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
callAnalytics {
summary
sentiment
transcript
}
communicationId
clientId
patientId
employeeId
communicationType
communication
contactDatetime
status
mediaId
mangoWebhookRequestId
voidReason
createdAt
updatedAt
}
}
Variables
{"input": CommunicationCreateSchema}
Response
{
"data": {
"addCommunication": {
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"patient": PatientSchema,
"media": MediaSchema,
"callAnalytics": CallSummaryAnalyticsSchema,
"communicationId": "4",
"clientId": "4",
"patientId": 4,
"employeeId": "4",
"communicationType": "PHONE",
"communication": "abc123",
"contactDatetime": datetime,
"status": "OPEN",
"mediaId": 4,
"mangoWebhookRequestId": "xyz789",
"voidReason": "abc123",
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addConversationParticipant
Response
Returns a ConversationSchema!
Example
Query
mutation AddConversationParticipant(
$employeeId: ID!,
$conversationId: ID!,
$messageId: ID
) {
addConversationParticipant(
employeeId: $employeeId,
conversationId: $conversationId,
messageId: $messageId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{
"employeeId": "4",
"conversationId": "4",
"messageId": null
}
Response
{
"data": {
"addConversationParticipant": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": "4",
"createdAt": datetime,
"updatedAt": datetime,
"clientId": 4,
"unknownPhoneNumber": "xyz789",
"isArchived": false,
"readAt": datetime,
"unreadCount": 123,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
addEmployee
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
input - EmployeeCreateSchema!
|
Example
Query
mutation AddEmployee($input: EmployeeCreateSchema!) {
addEmployee(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": EmployeeCreateSchema}
Response
{
"data": {
"addEmployee": {
"profilePicture": MediaSchema,
"id": "4",
"firstName": "abc123",
"lastName": "abc123",
"emailH": "xyz789",
"emailW": "abc123",
"phoneH": "xyz789",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": false,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
addFamily
Response
Returns a FamilyViewSchema!
Arguments
| Name | Description |
|---|---|
familyName - String!
|
|
clientFirstName - String!
|
|
clientLastName - String!
|
|
clientPhone - String!
|
|
clientPhoneW - String
|
Default = null |
clientPhoneHType - PhoneType
|
Default = null |
clientPhoneWType - PhoneType
|
Default = null |
preferredCommunicationMethods - [PreferredCommunicationMethods!]
|
Default = null |
patientFirstName - String
|
Default = null |
patientSpecies - String
|
Default = null |
clientEmail - String
|
Default = null |
clientStatus - UserStatus
|
Default = null |
clientDateOfBirth - datetime
|
Default = null |
smsConsent - SmsConsent
|
Default = UNKNOWN |
street - String
|
Default = null |
city - String
|
Default = null |
state - String
|
Default = null |
zipCode - String
|
Default = null |
patientStatus - PatientStatus
|
Default = null |
patientBreed - String
|
Default = null |
patientDateOfBirth - datetime
|
Default = null |
patientColor - String
|
Default = null |
patientGender - Gender
|
Default = null |
patientSpayNeuter - Boolean
|
Default = null |
patientMicrochip - String
|
Default = null |
status - FamilyStatus
|
Default = ACTIVE |
clientGroupDiscountId - ID
|
Default = null |
bypassClientExistenceCheck - Boolean
|
Default = false |
Example
Query
mutation AddFamily(
$familyName: String!,
$clientFirstName: String!,
$clientLastName: String!,
$clientPhone: String!,
$clientPhoneW: String,
$clientPhoneHType: PhoneType,
$clientPhoneWType: PhoneType,
$preferredCommunicationMethods: [PreferredCommunicationMethods!],
$patientFirstName: String,
$patientSpecies: String,
$clientEmail: String,
$clientStatus: UserStatus,
$clientDateOfBirth: datetime,
$smsConsent: SmsConsent,
$street: String,
$city: String,
$state: String,
$zipCode: String,
$patientStatus: PatientStatus,
$patientBreed: String,
$patientDateOfBirth: datetime,
$patientColor: String,
$patientGender: Gender,
$patientSpayNeuter: Boolean,
$patientMicrochip: String,
$status: FamilyStatus,
$clientGroupDiscountId: ID,
$bypassClientExistenceCheck: Boolean
) {
addFamily(
familyName: $familyName,
clientFirstName: $clientFirstName,
clientLastName: $clientLastName,
clientPhone: $clientPhone,
clientPhoneW: $clientPhoneW,
clientPhoneHType: $clientPhoneHType,
clientPhoneWType: $clientPhoneWType,
preferredCommunicationMethods: $preferredCommunicationMethods,
patientFirstName: $patientFirstName,
patientSpecies: $patientSpecies,
clientEmail: $clientEmail,
clientStatus: $clientStatus,
clientDateOfBirth: $clientDateOfBirth,
smsConsent: $smsConsent,
street: $street,
city: $city,
state: $state,
zipCode: $zipCode,
patientStatus: $patientStatus,
patientBreed: $patientBreed,
patientDateOfBirth: $patientDateOfBirth,
patientColor: $patientColor,
patientGender: $patientGender,
patientSpayNeuter: $patientSpayNeuter,
patientMicrochip: $patientMicrochip,
status: $status,
clientGroupDiscountId: $clientGroupDiscountId,
bypassClientExistenceCheck: $bypassClientExistenceCheck
) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{
"familyName": "abc123",
"clientFirstName": "xyz789",
"clientLastName": "abc123",
"clientPhone": "abc123",
"clientPhoneW": null,
"clientPhoneHType": "null",
"clientPhoneWType": "null",
"preferredCommunicationMethods": ["ul"],
"patientFirstName": null,
"patientSpecies": null,
"clientEmail": null,
"clientStatus": "null",
"clientDateOfBirth": null,
"smsConsent": "UNKNOWN",
"street": null,
"city": null,
"state": null,
"zipCode": null,
"patientStatus": "null",
"patientBreed": null,
"patientDateOfBirth": null,
"patientColor": null,
"patientGender": "null",
"patientSpayNeuter": null,
"patientMicrochip": null,
"status": "ACTIVE",
"clientGroupDiscountId": null,
"bypassClientExistenceCheck": false
}
Response
{
"data": {
"addFamily": {
"id": "4",
"familyId": 4,
"familyName": "abc123",
"familyNameLowercase": "xyz789",
"familyExtId": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 123,
"status": "ACTIVE",
"primaryContactUid": "4",
"secondaryContactUid": "4",
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
addFormToSoap
Response
Returns a SoapSchema!
Arguments
| Name | Description |
|---|---|
input - SoapAddFormSchema!
|
Example
Query
mutation AddFormToSoap($input: SoapAddFormSchema!) {
addFormToSoap(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"input": SoapAddFormSchema}
Response
{
"data": {
"addFormToSoap": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": "4",
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": "4",
"vetUid": "4",
"voiceNoteId": 4,
"details": "xyz789",
"subjective": "abc123",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "xyz789",
"forms": [4],
"voiceNoteApprovedSignature": "xyz789"
}
}
}
addInventoryItem
Response
Returns an InventoryItemSchema!
Arguments
| Name | Description |
|---|---|
input - InventoryItemCreateSchema!
|
Example
Query
mutation AddInventoryItem($input: InventoryItemCreateSchema!) {
addInventoryItem(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
unitCost
totalCost
sku
uom
inventoryQuantities {
vendorId
locationId
quantityOnHand
sellRatio
createdAt
updatedAt
}
inventoryLot {
lotId
manufacturer
serialNo
ndcNumber
quantityReceived
quantityRemaining
expiredAt
receivedAt
manufacturedAt
deletedAt
createdAt
updatedAt
}
treatmentId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": InventoryItemCreateSchema}
Response
{
"data": {
"addInventoryItem": {
"treatment": TreatmentSchema,
"id": "4",
"unitCost": 123,
"totalCost": 987,
"sku": "xyz789",
"uom": "abc123",
"inventoryQuantities": [InventoryQuantitySchema],
"inventoryLot": InventoryLotSchema,
"treatmentId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addLabToOrderNote
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
orderNoteId - ID!
|
|
patientId - ID!
|
|
input - LabCreateSchema!
|
Example
Query
mutation AddLabToOrderNote(
$orderNoteId: ID!,
$patientId: ID!,
$input: LabCreateSchema!
) {
addLabToOrderNote(
orderNoteId: $orderNoteId,
patientId: $patientId,
input: $input
) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{
"orderNoteId": 4,
"patientId": 4,
"input": LabCreateSchema
}
Response
{
"data": {
"addLabToOrderNote": {
"idexxUiUrl": "abc123",
"orderPdfUrl": "abc123",
"resultPdfUrl": "xyz789",
"antechV6OrderUiUrl": "xyz789",
"antechV6ResultUiUrl": "abc123",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "abc123",
"id": "4",
"treatmentId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": [4],
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": 4,
"patientId": 4,
"instructions": "abc123",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"deletedAt": datetime
}
}
}
addLabToPatient
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
|
input - LabCreateSchema!
|
Example
Query
mutation AddLabToPatient(
$patientId: ID!,
$input: LabCreateSchema!
) {
addLabToPatient(
patientId: $patientId,
input: $input
) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"patientId": 4, "input": LabCreateSchema}
Response
{
"data": {
"addLabToPatient": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "xyz789",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "xyz789",
"antechV6ResultUiUrl": "xyz789",
"notes": "abc123",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "xyz789",
"idexxResultUrl": "xyz789",
"id": "4",
"treatmentId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": "4",
"patientId": 4,
"instructions": "abc123",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"deletedAt": datetime
}
}
}
addLabToSoap
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
soapId - ID!
|
|
patientId - ID!
|
|
input - LabCreateSchema!
|
Example
Query
mutation AddLabToSoap(
$soapId: ID!,
$patientId: ID!,
$input: LabCreateSchema!
) {
addLabToSoap(
soapId: $soapId,
patientId: $patientId,
input: $input
) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{
"soapId": 4,
"patientId": "4",
"input": LabCreateSchema
}
Response
{
"data": {
"addLabToSoap": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "abc123",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "xyz789",
"antechV6ResultUiUrl": "abc123",
"notes": "abc123",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "abc123",
"id": "4",
"treatmentId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": [4],
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": 4,
"patientId": "4",
"instructions": "xyz789",
"isStaff": true,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
}
}
addLabToSurgery
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
surgeryId - ID!
|
|
patientId - ID!
|
|
input - LabCreateSchema!
|
Example
Query
mutation AddLabToSurgery(
$surgeryId: ID!,
$patientId: ID!,
$input: LabCreateSchema!
) {
addLabToSurgery(
surgeryId: $surgeryId,
patientId: $patientId,
input: $input
) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{
"surgeryId": "4",
"patientId": 4,
"input": LabCreateSchema
}
Response
{
"data": {
"addLabToSurgery": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "abc123",
"resultPdfUrl": "xyz789",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "xyz789",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "xyz789",
"id": 4,
"treatmentId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"patientId": "4",
"instructions": "xyz789",
"isStaff": false,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
}
}
addLabToVisitNote
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
visitNoteId - ID!
|
|
patientId - ID!
|
|
input - LabCreateSchema!
|
Example
Query
mutation AddLabToVisitNote(
$visitNoteId: ID!,
$patientId: ID!,
$input: LabCreateSchema!
) {
addLabToVisitNote(
visitNoteId: $visitNoteId,
patientId: $patientId,
input: $input
) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{
"visitNoteId": "4",
"patientId": "4",
"input": LabCreateSchema
}
Response
{
"data": {
"addLabToVisitNote": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "xyz789",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "abc123",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "xyz789",
"idexxResultUrl": "xyz789",
"id": "4",
"treatmentId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": "4",
"patientId": "4",
"instructions": "xyz789",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"deletedAt": datetime
}
}
}
addLocation
Response
Returns a LocationSchema!
Arguments
| Name | Description |
|---|---|
input - LocationCreateSchema!
|
Example
Query
mutation AddLocation($input: LocationCreateSchema!) {
addLocation(input: $input) {
id
name
description
deletedAt
}
}
Variables
{"input": LocationCreateSchema}
Response
{
"data": {
"addLocation": {
"id": 4,
"name": "abc123",
"description": "abc123",
"deletedAt": datetime
}
}
}
addMedia
Response
Returns a MediaSchema!
Arguments
| Name | Description |
|---|---|
input - MediaCreateSchema!
|
Example
Query
mutation AddMedia($input: MediaCreateSchema!) {
addMedia(input: $input) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"input": MediaCreateSchema}
Response
{
"data": {
"addMedia": {
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "abc123",
"deletedAt": "xyz789",
"title": "abc123",
"description": "xyz789",
"summaryGeneratedByAi": true,
"transcript": "xyz789",
"key": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
addOnlineAppointment
Response
Returns an AppointmentSchema!
Arguments
| Name | Description |
|---|---|
input - AppointmentCreateSchema!
|
Example
Query
mutation AddOnlineAppointment($input: AppointmentCreateSchema!) {
addOnlineAppointment(input: $input) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{"input": AppointmentCreateSchema}
Response
{
"data": {
"addOnlineAppointment": {
"appointmentId": 4,
"assignedUid": "4",
"creatorUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": 4,
"patient": PatientSchema,
"clientId": 4,
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": false,
"isRecurring": true,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": false,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": false,
"convertToLocal": true
}
}
}
addOrderNote
Response
Returns an OrderNoteSchema!
Arguments
| Name | Description |
|---|---|
input - OrderNoteCreateSchema!
|
Example
Query
mutation AddOrderNote($input: OrderNoteCreateSchema!) {
addOrderNote(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
notes
}
}
Variables
{"input": OrderNoteCreateSchema}
Response
{
"data": {
"addOrderNote": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": "4",
"creatorUid": 4,
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"notes": "abc123"
}
}
}
addPatient
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
input - PatientCreateSchema!
|
Example
Query
mutation AddPatient($input: PatientCreateSchema!) {
addPatient(input: $input) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"input": PatientCreateSchema}
Response
{
"data": {
"addPatient": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "abc123",
"familyId": "4",
"contactUid": "4",
"firstName": "xyz789",
"status": "ACTIVE",
"species": "abc123",
"lastName": "xyz789",
"breed": "abc123",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 123.45,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": false,
"photoUrl": "abc123",
"warnings": "abc123",
"microchip": "xyz789",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addPatientVitals
Response
Returns a PatientVitalSchema!
Arguments
| Name | Description |
|---|---|
input - PatientVitalCreateSchema!
|
Example
Query
mutation AddPatientVitals($input: PatientVitalCreateSchema!) {
addPatientVitals(input: $input) {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
}
Variables
{"input": PatientVitalCreateSchema}
Response
{
"data": {
"addPatientVitals": {
"visitNoteId": 4,
"patientVitalId": "4",
"patientId": "4",
"employeeUid": "4",
"soapId": 4,
"surgeryId": "4",
"bcs": 123,
"weightLb": 123.45,
"weightKg": 123.45,
"heartRate": 987,
"tempF": 123.45,
"tempC": 987.65,
"resp": 987,
"bpDia": 123,
"bpSys": 987,
"crt": 123.45,
"painScore": 123,
"periodontalDisease": 987,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addRole
Response
Returns a RoleSchema!
Arguments
| Name | Description |
|---|---|
input - RoleCreateSchema!
|
Example
Query
mutation AddRole($input: RoleCreateSchema!) {
addRole(input: $input) {
id
name
permissions
systemRole
sisterClinics
createdAt
updatedAt
}
}
Variables
{"input": RoleCreateSchema}
Response
{
"data": {
"addRole": {
"id": "4",
"name": "xyz789",
"permissions": ["xyz789"],
"systemRole": true,
"sisterClinics": ["abc123"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addSisterLocations
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
locations - [String!]!
|
Example
Query
mutation AddSisterLocations($locations: [String!]!) {
addSisterLocations(locations: $locations)
}
Variables
{"locations": ["abc123"]}
Response
{"data": {"addSisterLocations": ["xyz789"]}}
addSoap
Response
Returns a SoapSchema!
Arguments
| Name | Description |
|---|---|
input - SoapCreateSchema!
|
Example
Query
mutation AddSoap($input: SoapCreateSchema!) {
addSoap(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"input": SoapCreateSchema}
Response
{
"data": {
"addSoap": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": "4",
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": 4,
"vetUid": "4",
"voiceNoteId": 4,
"details": "xyz789",
"subjective": "abc123",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "xyz789",
"forms": [4],
"voiceNoteApprovedSignature": "xyz789"
}
}
}
addStoreCredits
Response
Returns a FamilyViewSchema!
Example
Query
mutation AddStoreCredits(
$familyId: ID!,
$creatorId: ID!,
$amount: Int!,
$reason: String!
) {
addStoreCredits(
familyId: $familyId,
creatorId: $creatorId,
amount: $amount,
reason: $reason
) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{
"familyId": "4",
"creatorId": 4,
"amount": 123,
"reason": "xyz789"
}
Response
{
"data": {
"addStoreCredits": {
"id": "4",
"familyId": "4",
"familyName": "abc123",
"familyNameLowercase": "abc123",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 123,
"storeCreditBalance": 123,
"status": "ACTIVE",
"primaryContactUid": "4",
"secondaryContactUid": "4",
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
addSurgery
Response
Returns a SurgerySchema!
Arguments
| Name | Description |
|---|---|
input - SurgeryCreateSchema!
|
Example
Query
mutation AddSurgery($input: SurgeryCreateSchema!) {
addSurgery(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
procedure
preop {
asaScore
notes
}
intraop {
anesthesiaStartAt
anesthesiaEndAt
procedureStartAt
procedureEndAt
medicationNotes
procedureNotes
}
postop {
numOxygenationMin
isEttExtubated
notes
}
recordedSurgeryVitals {
values {
...SurgeryVitalValueSchemaFragment
}
createdAt
}
}
}
Variables
{"input": SurgeryCreateSchema}
Response
{
"data": {
"addSurgery": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": "4",
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"procedure": "xyz789",
"preop": PreopSchema,
"intraop": IntraopSchema,
"postop": PostopSchema,
"recordedSurgeryVitals": [
RecordedSurgeryVitalSchema
]
}
}
}
addSurgeryVital
Response
Returns a SurgeryVitalSchema!
Arguments
| Name | Description |
|---|---|
input - SurgeryVitalCreateSchema!
|
Example
Query
mutation AddSurgeryVital($input: SurgeryVitalCreateSchema!) {
addSurgeryVital(input: $input) {
id
name
order
}
}
Variables
{"input": SurgeryVitalCreateSchema}
Response
{
"data": {
"addSurgeryVital": {
"id": 4,
"name": "xyz789",
"order": 987
}
}
}
addTaskNote
Response
Returns a TaskSchema!
Arguments
| Name | Description |
|---|---|
input - TaskNoteCreateSchema!
|
Example
Query
mutation AddTaskNote($input: TaskNoteCreateSchema!) {
addTaskNote(input: $input) {
id
patientId
clientId
creatorId
assignedById
assigneeId
taskType
priority
status
description
dueAt
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": TaskNoteCreateSchema}
Response
{
"data": {
"addTaskNote": {
"id": "4",
"patientId": 4,
"clientId": "4",
"creatorId": 4,
"assignedById": 4,
"assigneeId": "4",
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "abc123",
"dueAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addTreatment
Response
Returns a TreatmentSchema!
Arguments
| Name | Description |
|---|---|
input - TreatmentCreateSchema!
|
Example
Query
mutation AddTreatment($input: TreatmentCreateSchema!) {
addTreatment(input: $input) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
treatmentId
relativeDueTime
}
satisfyReminders {
treatmentId
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
rate
threshold
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
treatmentId
quantity
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
}
Variables
{"input": TreatmentCreateSchema}
Response
{
"data": {
"addTreatment": {
"dischargeDocuments": [DischargeDocumentSchema],
"treatmentId": 4,
"name": "xyz789",
"unit": "ML",
"pricePerUnit": 123,
"instructions": "abc123",
"adminFee": 123,
"minimumCharge": 123,
"customDoseUnit": "abc123",
"duration": 987,
"durUnit": "MINUTES",
"refills": 123,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"dischargeDocumentIds": ["4"],
"type": "xyz789",
"typeCode": "xyz789",
"category": "abc123",
"categoryCode": "xyz789",
"subCategory": "xyz789",
"subCategoryCode": "xyz789",
"isTaxable": false,
"isPstTaxable": true,
"isDiscountable": false,
"isControlledSubstance": false,
"generateReminders": [
TreatmentReminderGenerateSchema
],
"satisfyReminders": [
TreatmentReminderSatisfySchema
],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"deactivatePatientOnCheckout": false,
"spayPatientOnCheckout": true,
"useHistoricalHigh": true,
"discountRates": [DiscountRateSchema],
"isProvisional": true,
"useAsDefaultNoProvisional": false,
"labCat": "IN_HOUSE",
"labCode": "abc123",
"labDevice": "abc123",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "abc123",
"inventoryEnabled": false,
"inventoryTreatmentId": 4,
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": false,
"compoundInventoryItems": [
CompoundInventoryItemSchema
],
"vetcoveEnabled": false,
"minimumQuantity": Decimal,
"quantityRemaining": Decimal,
"furthestExpiredAt": "abc123",
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 987,
"clinicCostPerUnit": 123,
"useVendorCost": true,
"vendorListPrice": 987,
"route": "ORAL",
"freq": "abc123",
"manufacturer": "abc123",
"vaccine": "abc123",
"lotNo": "xyz789",
"expDate": datetime,
"species": "abc123",
"dose": Decimal
}
}
}
addVendor
Response
Returns a VendorSchema!
Arguments
| Name | Description |
|---|---|
input - VendorCreateSchema!
|
Example
Query
mutation AddVendor($input: VendorCreateSchema!) {
addVendor(input: $input) {
id
name
contactName
contactEmail
vetcoveId
type
accountNumber
website
deletedAt
}
}
Variables
{"input": VendorCreateSchema}
Response
{
"data": {
"addVendor": {
"id": "4",
"name": "abc123",
"contactName": "abc123",
"contactEmail": "abc123",
"vetcoveId": 987,
"type": "MANUFACTURER",
"accountNumber": "xyz789",
"website": "abc123",
"deletedAt": datetime
}
}
}
addVisitNote
Response
Returns a VisitNoteSchema!
Arguments
| Name | Description |
|---|---|
input - VisitNoteCreateSchema!
|
Example
Query
mutation AddVisitNote($input: VisitNoteCreateSchema!) {
addVisitNote(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
voiceNoteId
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
}
}
Variables
{"input": VisitNoteCreateSchema}
Response
{
"data": {
"addVisitNote": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": "4",
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"voiceNoteId": "4",
"notes": "abc123",
"details": "abc123",
"recs": "xyz789",
"assessment": SoapAssessmentSchema
}
}
}
addXrayToOrderNote
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
orderNoteId - ID!
|
|
patientId - ID!
|
|
input - XrayCreateSchema!
|
Example
Query
mutation AddXrayToOrderNote(
$orderNoteId: ID!,
$patientId: ID!,
$input: XrayCreateSchema!
) {
addXrayToOrderNote(
orderNoteId: $orderNoteId,
patientId: $patientId,
input: $input
) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{
"orderNoteId": "4",
"patientId": "4",
"input": XrayCreateSchema
}
Response
{
"data": {
"addXrayToOrderNote": {
"resultUrl": "abc123",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": "4",
"treatmentId": 4,
"patientId": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"isStaff": false,
"providerId": "4",
"status": "NEW",
"notes": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addXrayToPatient
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
patientId - ID!
|
|
input - XrayCreateSchema!
|
Example
Query
mutation AddXrayToPatient(
$patientId: ID!,
$input: XrayCreateSchema!
) {
addXrayToPatient(
patientId: $patientId,
input: $input
) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{
"patientId": "4",
"input": XrayCreateSchema
}
Response
{
"data": {
"addXrayToPatient": {
"resultUrl": "abc123",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": "4",
"treatmentId": "4",
"patientId": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"isStaff": true,
"providerId": "4",
"status": "NEW",
"notes": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addXrayToSoap
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
soapId - ID!
|
|
patientId - ID!
|
|
input - XrayCreateSchema!
|
Example
Query
mutation AddXrayToSoap(
$soapId: ID!,
$patientId: ID!,
$input: XrayCreateSchema!
) {
addXrayToSoap(
soapId: $soapId,
patientId: $patientId,
input: $input
) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{"soapId": 4, "patientId": 4, "input": XrayCreateSchema}
Response
{
"data": {
"addXrayToSoap": {
"resultUrl": "xyz789",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": 4,
"treatmentId": "4",
"patientId": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"isStaff": false,
"providerId": "4",
"status": "NEW",
"notes": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addXrayToSurgery
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
surgeryId - ID!
|
|
patientId - ID!
|
|
input - XrayCreateSchema!
|
Example
Query
mutation AddXrayToSurgery(
$surgeryId: ID!,
$patientId: ID!,
$input: XrayCreateSchema!
) {
addXrayToSurgery(
surgeryId: $surgeryId,
patientId: $patientId,
input: $input
) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{
"surgeryId": "4",
"patientId": 4,
"input": XrayCreateSchema
}
Response
{
"data": {
"addXrayToSurgery": {
"resultUrl": "abc123",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": 4,
"treatmentId": "4",
"patientId": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"notes": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
addXrayToVisitNote
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
visitNoteId - ID!
|
|
patientId - ID!
|
|
input - XrayCreateSchema!
|
Example
Query
mutation AddXrayToVisitNote(
$visitNoteId: ID!,
$patientId: ID!,
$input: XrayCreateSchema!
) {
addXrayToVisitNote(
visitNoteId: $visitNoteId,
patientId: $patientId,
input: $input
) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{
"visitNoteId": "4",
"patientId": "4",
"input": XrayCreateSchema
}
Response
{
"data": {
"addXrayToVisitNote": {
"resultUrl": "xyz789",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": "4",
"treatmentId": 4,
"patientId": "4",
"soapId": 4,
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": 4,
"isStaff": false,
"providerId": "4",
"status": "NEW",
"notes": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
applyStoreCredits
Response
Returns a FamilyViewSchema!
Example
Query
mutation ApplyStoreCredits(
$familyId: ID!,
$creatorId: ID!
) {
applyStoreCredits(
familyId: $familyId,
creatorId: $creatorId
) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{"familyId": 4, "creatorId": "4"}
Response
{
"data": {
"applyStoreCredits": {
"id": 4,
"familyId": 4,
"familyName": "xyz789",
"familyNameLowercase": "abc123",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 123,
"status": "ACTIVE",
"primaryContactUid": 4,
"secondaryContactUid": "4",
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
approveEstimate
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
input - EstimateApproveSchema!
|
Example
Query
mutation ApproveEstimate($input: EstimateApproveSchema!) {
approveEstimate(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimateApproveSchema}
Response
{
"data": {
"approveEstimate": {
"soap": SoapSchema,
"estimateId": 4,
"status": "OPEN",
"patientId": "4",
"creatorUid": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"items": [EstimateItemSchema],
"isRange": true,
"minSubtotal": 123,
"maxSubtotal": 123,
"isTaxExempt": true,
"minTax": 123,
"maxTax": 123,
"minPstTax": 123,
"maxPstTax": 123,
"taxRate": 123.45,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 123,
"minTotal": 123,
"maxTotal": 123,
"approved": false,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "abc123",
"clientId": "4",
"otherApproverName": "abc123",
"media": [MediaSchema],
"title": "abc123",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
askCoco
Response
Returns an AskCoCoResponse!
Arguments
| Name | Description |
|---|---|
request - AskCoCoRequest!
|
Example
Query
mutation AskCoco($request: AskCoCoRequest!) {
askCoco(request: $request) {
content
docs {
origItems {
... on CommunicationSchema {
...CommunicationSchemaFragment
}
... on EstimateSchema {
...EstimateSchemaFragment
}
... on FamilyViewSchema {
...FamilyViewSchemaFragment
}
... on InvoiceViewSchema {
...InvoiceViewSchemaFragment
}
... on LabSchema {
...LabSchemaFragment
}
... on LabResultSchema {
...LabResultSchemaFragment
}
... on PrescriptionOrderSchema {
...PrescriptionOrderSchemaFragment
}
... on PrescriptionFillSchema {
...PrescriptionFillSchemaFragment
}
... on MiscNoteSchema {
...MiscNoteSchemaFragment
}
... on ConversationMessageSchema {
...ConversationMessageSchemaFragment
}
... on RxScriptSchema {
...RxScriptSchemaFragment
}
... on SoapSchema {
...SoapSchemaFragment
}
... on SurgerySchema {
...SurgerySchemaFragment
}
... on VisitNoteSchema {
...VisitNoteSchemaFragment
}
... on OrderNoteSchema {
...OrderNoteSchemaFragment
}
... on VaccineSchema {
...VaccineSchemaFragment
}
... on MediaSchema {
...MediaSchemaFragment
}
... on FormSubmissionViewSchema {
...FormSubmissionViewSchemaFragment
}
... on XraySchema {
...XraySchemaFragment
}
... on PatientVitalSchema {
...PatientVitalSchemaFragment
}
... on TaskSchema {
...TaskSchemaFragment
}
... on LinkSchema {
...LinkSchemaFragment
}
... on TreatmentPlanViewSchema {
...TreatmentPlanViewSchemaFragment
}
... on EmailLogSchema {
...EmailLogSchemaFragment
}
}
id
patientId
type
origItemIds
deletedAt
createdAt
updatedAt
displayDate
displayString
}
}
}
Variables
{"request": AskCoCoRequest}
Response
{
"data": {
"askCoco": {
"content": "abc123",
"docs": [MedicalHistoryViewSchema]
}
}
}
attachPaymentMethod
Example
Query
mutation AttachPaymentMethod(
$clientId: ID!,
$paymentMethodId: String!
) {
attachPaymentMethod(
clientId: $clientId,
paymentMethodId: $paymentMethodId
)
}
Variables
{
"clientId": "4",
"paymentMethodId": "abc123"
}
Response
{"data": {"attachPaymentMethod": true}}
batchScheduleUpdate
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - BatchScheduleUpdateSchema!
|
Example
Query
mutation BatchScheduleUpdate($input: BatchScheduleUpdateSchema!) {
batchScheduleUpdate(input: $input)
}
Variables
{"input": BatchScheduleUpdateSchema}
Response
{"data": {"batchScheduleUpdate": true}}
billAndPayInvoices
Response
Returns an InvoiceBillingAndPaymentResponse!
Arguments
| Name | Description |
|---|---|
input - InvoiceBillingAndPaymentSchema!
|
Example
Query
mutation BillAndPayInvoices($input: InvoiceBillingAndPaymentSchema!) {
billAndPayInvoices(input: $input) {
success
message
paymentInvoiceIds
totalPaid
accountBalanceUsed
creditUsed
paymentUsed
}
}
Variables
{"input": InvoiceBillingAndPaymentSchema}
Response
{
"data": {
"billAndPayInvoices": {
"success": true,
"message": "abc123",
"paymentInvoiceIds": ["4"],
"totalPaid": 123,
"accountBalanceUsed": 987,
"creditUsed": 123,
"paymentUsed": 987
}
}
}
calculateInterestCharge
Response
Returns a FamilyViewSchema!
Example
Query
mutation CalculateInterestCharge(
$familyId: ID!,
$runForMonth: datetime!
) {
calculateInterestCharge(
familyId: $familyId,
runForMonth: $runForMonth
) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{"familyId": 4, "runForMonth": datetime}
Response
{
"data": {
"calculateInterestCharge": {
"id": 4,
"familyId": "4",
"familyName": "xyz789",
"familyNameLowercase": "xyz789",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": "4",
"secondaryContactUid": 4,
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
cancelBoardingReservation
cancelLab
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation CancelLab($id: ID!) {
cancelLab(id: $id) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"cancelLab": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "xyz789",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "xyz789",
"antechV6ResultUiUrl": "abc123",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "xyz789",
"idexxResultUrl": "xyz789",
"id": "4",
"treatmentId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": [4],
"soapId": 4,
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": 4,
"patientId": "4",
"instructions": "abc123",
"isStaff": true,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
}
}
cancelPaymentsAndVoidInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - CancelPaymentsAndVoidInvoiceSchema!
|
Example
Query
mutation CancelPaymentsAndVoidInvoice($input: CancelPaymentsAndVoidInvoiceSchema!) {
cancelPaymentsAndVoidInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": CancelPaymentsAndVoidInvoiceSchema}
Response
{
"data": {
"cancelPaymentsAndVoidInvoice": {
"invoiceId": "4",
"patientId": "4",
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": "4",
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 987,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 123,
"total": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": false,
"storeCreditApplied": 123,
"storeCreditManuallySet": false,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": false,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
}
}
cancelReceivingPurchaseOrderItem
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CancelReceivingPurchaseOrderItemSchema!
|
Example
Query
mutation CancelReceivingPurchaseOrderItem($input: CancelReceivingPurchaseOrderItemSchema!) {
cancelReceivingPurchaseOrderItem(input: $input)
}
Variables
{"input": CancelReceivingPurchaseOrderItemSchema}
Response
{"data": {"cancelReceivingPurchaseOrderItem": true}}
cancelSubscription
Response
Returns a SubscriptionSchema!
Arguments
| Name | Description |
|---|---|
input - CancelSubscriptionInput!
|
Example
Query
mutation CancelSubscription($input: CancelSubscriptionInput!) {
cancelSubscription(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"input": CancelSubscriptionInput}
Response
{
"data": {
"cancelSubscription": {
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "xyz789",
"accountId": "xyz789",
"customerId": "abc123",
"status": "ACTIVE",
"price": 123,
"currency": "AUD",
"intervalUnit": "abc123",
"intervalCount": 987,
"paymentMethodId": "xyz789",
"platformFeeAmount": 987,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
}
}
cancelXray
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation CancelXray($id: ID!) {
cancelXray(id: $id) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"cancelXray": {
"resultUrl": "abc123",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": 4,
"treatmentId": "4",
"patientId": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": 4,
"isStaff": false,
"providerId": "4",
"status": "NEW",
"notes": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
captureCardPresentSession
Response
Returns a CardPresentSessionSchema!
Arguments
| Name | Description |
|---|---|
input - CaptureCardPresentSessionSchema!
|
Example
Query
mutation CaptureCardPresentSession($input: CaptureCardPresentSessionSchema!) {
captureCardPresentSession(input: $input) {
id
amount
paymentIntentId
paymentMethodId
terminalId
paymentIntentStatus
createdAt
updatedAt
}
}
Variables
{"input": CaptureCardPresentSessionSchema}
Response
{
"data": {
"captureCardPresentSession": {
"id": "abc123",
"amount": 123,
"paymentIntentId": "abc123",
"paymentMethodId": "abc123",
"terminalId": "abc123",
"paymentIntentStatus": "CANCELED",
"createdAt": datetime,
"updatedAt": datetime
}
}
}
checkoutTreatmentPlan
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation CheckoutTreatmentPlan($id: ID!) {
checkoutTreatmentPlan(id: $id) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"checkoutTreatmentPlan": {
"id": "4",
"patientId": "4",
"clientId": 4,
"providerId": "4",
"techUid": "4",
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
click2Call
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ClickToCallSchema!
|
Example
Query
mutation Click2Call($input: ClickToCallSchema!) {
click2Call(input: $input)
}
Variables
{"input": ClickToCallSchema}
Response
{"data": {"click2Call": true}}
connectAntechV6
Response
Returns a SettingsSchema!
Example
Query
mutation ConnectAntechV6(
$antechV6ClinicId: String!,
$antechV6Username: String!,
$antechV6Password: String!
) {
connectAntechV6(
antechV6ClinicId: $antechV6ClinicId,
antechV6Username: $antechV6Username,
antechV6Password: $antechV6Password
) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{
"antechV6ClinicId": "abc123",
"antechV6Username": "abc123",
"antechV6Password": "abc123"
}
Response
{
"data": {
"connectAntechV6": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"country": "abc123",
"zipCode": "abc123",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "xyz789",
"twilioPhone": "xyz789",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": false,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 987,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": false,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["xyz789"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": false,
"clinicIpAddress": "abc123"
}
}
}
connectEllie
Response
Returns a SettingsSchema!
Arguments
| Name | Description |
|---|---|
ellieClinicId - String!
|
Example
Query
mutation ConnectEllie($ellieClinicId: String!) {
connectEllie(ellieClinicId: $ellieClinicId) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{"ellieClinicId": "abc123"}
Response
{
"data": {
"connectEllie": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "abc123",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "abc123",
"state": "abc123",
"country": "abc123",
"zipCode": "abc123",
"name": "xyz789",
"status": "OPEN",
"email": "xyz789",
"phone": "abc123",
"twilioPhone": "xyz789",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": false,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": true,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": false,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": true,
"clinicIpAddress": "abc123"
}
}
}
connectHl7i
Response
Returns a SettingsSchema!
Arguments
| Name | Description |
|---|---|
input - Hl7iConnectSchema!
|
Example
Query
mutation ConnectHl7i($input: Hl7iConnectSchema!) {
connectHl7i(input: $input) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{"input": Hl7iConnectSchema}
Response
{
"data": {
"connectHl7i": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"country": "xyz789",
"zipCode": "abc123",
"name": "xyz789",
"status": "OPEN",
"email": "abc123",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "abc123",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
}
}
connectIdexx
Response
Returns a SettingsSchema!
Example
Query
mutation ConnectIdexx(
$idexxUsername: String!,
$idexxPassword: String!
) {
connectIdexx(
idexxUsername: $idexxUsername,
idexxPassword: $idexxPassword
) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{
"idexxUsername": "xyz789",
"idexxPassword": "abc123"
}
Response
{
"data": {
"connectIdexx": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "abc123",
"state": "xyz789",
"country": "xyz789",
"zipCode": "xyz789",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "abc123",
"twilioPhone": "xyz789",
"timezone": "xyz789",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "abc123",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 987,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 987,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": false,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": true,
"clinicIpAddress": "xyz789"
}
}
}
connectIdexxWebpacs
Response
Returns a SettingsSchema!
Arguments
| Name | Description |
|---|---|
idexxWebpacsUsername - String!
|
|
idexxWebpacsPassword - String!
|
|
idexxWebpacsClinicId - String
|
|
idexxWebpacsLocationTokens - [String!]!
|
Example
Query
mutation ConnectIdexxWebpacs(
$idexxWebpacsUsername: String!,
$idexxWebpacsPassword: String!,
$idexxWebpacsClinicId: String,
$idexxWebpacsLocationTokens: [String!]!
) {
connectIdexxWebpacs(
idexxWebpacsUsername: $idexxWebpacsUsername,
idexxWebpacsPassword: $idexxWebpacsPassword,
idexxWebpacsClinicId: $idexxWebpacsClinicId,
idexxWebpacsLocationTokens: $idexxWebpacsLocationTokens
) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{
"idexxWebpacsUsername": "abc123",
"idexxWebpacsPassword": "xyz789",
"idexxWebpacsClinicId": "abc123",
"idexxWebpacsLocationTokens": ["abc123"]
}
Response
{
"data": {
"connectIdexxWebpacs": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"country": "abc123",
"zipCode": "abc123",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": false,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 987,
"vitalsAutolockHours": 987,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": false,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "abc123",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": true,
"clinicIpAddress": "xyz789"
}
}
}
connectZoetis
Response
Returns a SettingsSchema!
Arguments
| Name | Description |
|---|---|
zoetisClientId - String!
|
Example
Query
mutation ConnectZoetis($zoetisClientId: String!) {
connectZoetis(zoetisClientId: $zoetisClientId) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{"zoetisClientId": "abc123"}
Response
{
"data": {
"connectZoetis": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"country": "xyz789",
"zipCode": "abc123",
"name": "xyz789",
"status": "OPEN",
"email": "xyz789",
"phone": "abc123",
"twilioPhone": "xyz789",
"timezone": "abc123",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": true,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "abc123",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": true,
"clinicIpAddress": "abc123"
}
}
}
copyUserCommissionSettings
Example
Query
mutation CopyUserCommissionSettings(
$fromUserId: ID!,
$toUserId: ID!
) {
copyUserCommissionSettings(
fromUserId: $fromUserId,
toUserId: $toUserId
)
}
Variables
{
"fromUserId": "4",
"toUserId": "4"
}
Response
{"data": {"copyUserCommissionSettings": false}}
createAddendum
Response
Returns an AddendumSchema!
Arguments
| Name | Description |
|---|---|
input - AddendumCreateSchema!
|
Example
Query
mutation CreateAddendum($input: AddendumCreateSchema!) {
createAddendum(input: $input) {
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": AddendumCreateSchema}
Response
{
"data": {
"createAddendum": {
"creator": ClinicUserSchema,
"id": 4,
"refId": "4",
"refType": "SOAP",
"creatorId": "4",
"description": "xyz789",
"timestamp": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createAiNoteSummary
Response
Returns a String
Arguments
| Name | Description |
|---|---|
input - CreateAINoteSummarySchema!
|
Example
Query
mutation CreateAiNoteSummary($input: CreateAINoteSummarySchema!) {
createAiNoteSummary(input: $input)
}
Variables
{"input": CreateAINoteSummarySchema}
Response
{"data": {"createAiNoteSummary": "xyz789"}}
createAppointmentType
Response
Returns an AppointmentTypeSchema!
Arguments
| Name | Description |
|---|---|
input - AppointmentTypeCreateSchema!
|
Example
Query
mutation CreateAppointmentType($input: AppointmentTypeCreateSchema!) {
createAppointmentType(input: $input) {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": AppointmentTypeCreateSchema}
Response
{
"data": {
"createAppointmentType": {
"id": 4,
"creatorId": 4,
"legacyKey": "abc123",
"name": "xyz789",
"category": "MEDICAL",
"description": "abc123",
"color": "abc123",
"defaultMinutes": 987,
"depositRequired": false,
"depositAmount": 987,
"order": 123,
"directOnlineEnabled": false,
"isRequired": false,
"sendReminderNotifications": true,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createBoardingReservation
Response
Returns a BoardingReservationSchema!
Arguments
| Name | Description |
|---|---|
input - BoardingReservationCreateSchema!
|
Example
Query
mutation CreateBoardingReservation($input: BoardingReservationCreateSchema!) {
createBoardingReservation(input: $input) {
id
creatorId
patientId
kennelId
startDatetime
endDatetime
notes
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": BoardingReservationCreateSchema}
Response
{
"data": {
"createBoardingReservation": {
"id": "4",
"creatorId": 4,
"patientId": "4",
"kennelId": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createBreed
Response
Returns a BreedSchema!
Arguments
| Name | Description |
|---|---|
input - BreedInputSchema!
|
Example
Query
mutation CreateBreed($input: BreedInputSchema!) {
createBreed(input: $input) {
breedId
name
species
imageData
}
}
Variables
{"input": BreedInputSchema}
Response
{
"data": {
"createBreed": {
"breedId": 4,
"name": "xyz789",
"species": "xyz789",
"imageData": "abc123"
}
}
}
createBundle
Response
Returns a BundleSchema!
Arguments
| Name | Description |
|---|---|
input - BundleCreateSchema!
|
Example
Query
mutation CreateBundle($input: BundleCreateSchema!) {
createBundle(input: $input) {
bundleId
name
treatments {
name
treatmentId
pricePerUnit
minimumQty
maximumQty
order
hideItem
}
createdAt
updatedAt
useQtyRange
hideAllItemsPrices
}
}
Variables
{"input": BundleCreateSchema}
Response
{
"data": {
"createBundle": {
"bundleId": 4,
"name": "xyz789",
"treatments": [BundleTreatmentSchema],
"createdAt": datetime,
"updatedAt": datetime,
"useQtyRange": true,
"hideAllItemsPrices": true
}
}
}
createCardPresentSession
Response
Returns a CreateCardPresentSessionSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceBillingAndPaymentSchema!
|
Example
Query
mutation CreateCardPresentSession($input: InvoiceBillingAndPaymentSchema!) {
createCardPresentSession(input: $input) {
cardPresentSessionId
paymentIntentId
}
}
Variables
{"input": InvoiceBillingAndPaymentSchema}
Response
{
"data": {
"createCardPresentSession": {
"cardPresentSessionId": 4,
"paymentIntentId": "xyz789"
}
}
}
createCheckoutSession
Response
Returns a CheckoutSessionSchema!
Arguments
| Name | Description |
|---|---|
input - TransactionCreateSchema!
|
Example
Query
mutation CreateCheckoutSession($input: TransactionCreateSchema!) {
createCheckoutSession(input: $input) {
id
accountId
amountTotal
createdAt
currency
paymentIntentId
paymentMethodTypes
status
updatedAt
url
cancelUrl
customerId
expiresAt
successUrl
}
}
Variables
{"input": TransactionCreateSchema}
Response
{
"data": {
"createCheckoutSession": {
"id": "abc123",
"accountId": "abc123",
"amountTotal": 987,
"createdAt": datetime,
"currency": "AUD",
"paymentIntentId": "xyz789",
"paymentMethodTypes": ["CARD"],
"status": "OPEN",
"updatedAt": datetime,
"url": "xyz789",
"cancelUrl": "abc123",
"customerId": "xyz789",
"expiresAt": datetime,
"successUrl": "abc123"
}
}
}
createColor
Response
Returns a ColorSchema!
Arguments
| Name | Description |
|---|---|
input - ColorInputSchema!
|
Example
Query
mutation CreateColor($input: ColorInputSchema!) {
createColor(input: $input) {
colorId
name
species
}
}
Variables
{"input": ColorInputSchema}
Response
{
"data": {
"createColor": {
"colorId": "4",
"name": "xyz789",
"species": "xyz789"
}
}
}
createCommissionSettings
Response
Returns a CommissionSettingSchema!
Arguments
| Name | Description |
|---|---|
input - CommissionSettingCreateSchema!
|
Example
Query
mutation CreateCommissionSettings($input: CommissionSettingCreateSchema!) {
createCommissionSettings(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
originalCommissionSettingId
typeName
typeCode
categoryName
categoryCode
treatmentId
commissionRate
userId
type
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": CommissionSettingCreateSchema}
Response
{
"data": {
"createCommissionSettings": {
"treatment": TreatmentSchema,
"id": 4,
"originalCommissionSettingId": 4,
"typeName": "abc123",
"typeCode": "xyz789",
"categoryName": "xyz789",
"categoryCode": "abc123",
"treatmentId": "4",
"commissionRate": 987.65,
"userId": "4",
"type": "TREATMENT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createDiagnosis
Response
Returns a DiagnosisSchema!
Arguments
| Name | Description |
|---|---|
input - DiagnosisCreateSchema!
|
Example
Query
mutation CreateDiagnosis($input: DiagnosisCreateSchema!) {
createDiagnosis(input: $input) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
name
source
dischargeDocumentIds
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": DiagnosisCreateSchema}
Response
{
"data": {
"createDiagnosis": {
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"name": "abc123",
"source": "AAHA",
"dischargeDocumentIds": ["4"],
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createDischargeDocument
Response
Returns a DischargeDocumentSchema!
Arguments
| Name | Description |
|---|---|
input - DischargeDocumentCreateSchema!
|
Example
Query
mutation CreateDischargeDocument($input: DischargeDocumentCreateSchema!) {
createDischargeDocument(input: $input) {
linkedDiagnoses {
id
name
}
linkedTreatments {
treatmentId
name
species
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": DischargeDocumentCreateSchema}
Response
{
"data": {
"createDischargeDocument": {
"linkedDiagnoses": [DiagnosisBasicSchema],
"linkedTreatments": [TreatmentBasicSchema],
"id": "4",
"fileName": "abc123",
"documentName": "xyz789",
"mediaId": 4,
"species": "xyz789",
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createDischargeDocumentWithLinks
Response
Returns a DischargeDocumentSchema!
Arguments
| Name | Description |
|---|---|
input - DischargeDocumentCreateWithLinksSchema!
|
Example
Query
mutation CreateDischargeDocumentWithLinks($input: DischargeDocumentCreateWithLinksSchema!) {
createDischargeDocumentWithLinks(input: $input) {
linkedDiagnoses {
id
name
}
linkedTreatments {
treatmentId
name
species
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": DischargeDocumentCreateWithLinksSchema}
Response
{
"data": {
"createDischargeDocumentWithLinks": {
"linkedDiagnoses": [DiagnosisBasicSchema],
"linkedTreatments": [TreatmentBasicSchema],
"id": 4,
"fileName": "xyz789",
"documentName": "abc123",
"mediaId": "4",
"species": "abc123",
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createEmailLog
Response
Returns an EmailLogSchema!
Arguments
| Name | Description |
|---|---|
input - EmailLogCreateSchema!
|
Example
Query
mutation CreateEmailLog($input: EmailLogCreateSchema!) {
createEmailLog(input: $input) {
attachments {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
sender
receiverEmails
patientId
subject
emailTemplateName
emailTemplateData
emailContent
attachmentIds
createdAt
updatedAt
}
}
Variables
{"input": EmailLogCreateSchema}
Response
{
"data": {
"createEmailLog": {
"attachments": [MediaSchema],
"id": 4,
"sender": "xyz789",
"receiverEmails": ["xyz789"],
"patientId": "4",
"subject": "xyz789",
"emailTemplateName": "xyz789",
"emailTemplateData": {},
"emailContent": "xyz789",
"attachmentIds": [4],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createEmailTemplate
Response
Returns an EmailTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - EmailTemplateCreateSchema!
|
Example
Query
mutation CreateEmailTemplate($input: EmailTemplateCreateSchema!) {
createEmailTemplate(input: $input) {
postFooter
availableVariables
id
name
description
key
templateKey
enabled
type
replyTo
subject
body
bodyJson
footer
footerJson
linkedFormIds
createdAt
updatedAt
}
}
Variables
{"input": EmailTemplateCreateSchema}
Response
{
"data": {
"createEmailTemplate": {
"postFooter": "xyz789",
"availableVariables": {},
"id": 4,
"name": "xyz789",
"description": "abc123",
"key": "abc123",
"templateKey": "abc123",
"enabled": true,
"type": "SYSTEM",
"replyTo": "xyz789",
"subject": "abc123",
"body": "abc123",
"bodyJson": "abc123",
"footer": "xyz789",
"footerJson": "abc123",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createEstimate
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
input - EstimateCreateSchema!
|
Example
Query
mutation CreateEstimate($input: EstimateCreateSchema!) {
createEstimate(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimateCreateSchema}
Response
{
"data": {
"createEstimate": {
"soap": SoapSchema,
"estimateId": 4,
"status": "OPEN",
"patientId": 4,
"creatorUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 987,
"maxSubtotal": 123,
"isTaxExempt": true,
"minTax": 987,
"maxTax": 123,
"minPstTax": 123,
"maxPstTax": 987,
"taxRate": 123.45,
"pstTaxRate": 987.65,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 987,
"minTotal": 987,
"maxTotal": 987,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": 4,
"otherApproverName": "abc123",
"media": [MediaSchema],
"title": "xyz789",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createForm
Response
Returns a FormSchema!
Arguments
| Name | Description |
|---|---|
input - FormCreateSchema!
|
Example
Query
mutation CreateForm($input: FormCreateSchema!) {
createForm(input: $input) {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": FormCreateSchema}
Response
{
"data": {
"createForm": {
"id": "4",
"title": "xyz789",
"description": "abc123",
"uiSchema": {},
"baseSchema": {},
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createFormSubmission
Response
Returns [FormSubmissionSchema!]!
Arguments
| Name | Description |
|---|---|
input - FormSubmissionCreateSchema!
|
Example
Query
mutation CreateFormSubmission($input: FormSubmissionCreateSchema!) {
createFormSubmission(input: $input) {
url
id
formId
formData
clientId
patientId
status
publicId
message
appointmentId
sentVia
sentBy
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"input": FormSubmissionCreateSchema}
Response
{
"data": {
"createFormSubmission": [
{
"url": "abc123",
"id": "4",
"formId": "4",
"formData": {},
"clientId": "4",
"patientId": 4,
"status": "SENT",
"publicId": "xyz789",
"message": "abc123",
"appointmentId": "4",
"sentVia": ["EMAIL"],
"sentBy": "4",
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
createFreemium
Response
Returns a FreemiumSchema!
Arguments
| Name | Description |
|---|---|
input - FreemiumCreateSchema!
|
Example
Query
mutation CreateFreemium($input: FreemiumCreateSchema!) {
createFreemium(input: $input) {
id
name
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": FreemiumCreateSchema}
Response
{
"data": {
"createFreemium": {
"id": 4,
"name": "xyz789",
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createFreemiumWithUser
Response
Returns a FreemiumSchema!
Arguments
| Name | Description |
|---|---|
input - CreateFreemiumWithUserSchema!
|
Example
Query
mutation CreateFreemiumWithUser($input: CreateFreemiumWithUserSchema!) {
createFreemiumWithUser(input: $input) {
id
name
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": CreateFreemiumWithUserSchema}
Response
{
"data": {
"createFreemiumWithUser": {
"id": "4",
"name": "xyz789",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createGroupDiscount
Response
Returns a GroupDiscountSchema!
Arguments
| Name | Description |
|---|---|
input - GroupDiscountCreateSchema!
|
Example
Query
mutation CreateGroupDiscount($input: GroupDiscountCreateSchema!) {
createGroupDiscount(input: $input) {
id
name
percentage
creatorId
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": GroupDiscountCreateSchema}
Response
{
"data": {
"createGroupDiscount": {
"id": "4",
"name": "abc123",
"percentage": Decimal,
"creatorId": "4",
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createInventoryTransaction
Response
Returns an InventoryTransactionSchema!
Arguments
| Name | Description |
|---|---|
input - InventoryTransactionCreateSchema!
|
Example
Query
mutation CreateInventoryTransaction($input: InventoryTransactionCreateSchema!) {
createInventoryTransaction(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
creatorId
reason
treatmentId
inventoryItemId
invoiceId
patientId
clientId
quantity
unitCost
cost
description
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": InventoryTransactionCreateSchema}
Response
{
"data": {
"createInventoryTransaction": {
"treatment": TreatmentSchema,
"id": 4,
"creatorId": "4",
"reason": "WASTAGE",
"treatmentId": 4,
"inventoryItemId": "4",
"invoiceId": "4",
"patientId": "4",
"clientId": "4",
"quantity": Decimal,
"unitCost": 987,
"cost": 123,
"description": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceCreateSchema!
|
Example
Query
mutation CreateInvoice($input: InvoiceCreateSchema!) {
createInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceCreateSchema}
Response
{
"data": {
"createInvoice": {
"invoiceId": "4",
"patientId": "4",
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"estimateId": 4,
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 123,
"total": 123,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": true,
"storeCreditApplied": 123,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": true,
"isMigrated": false,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 123,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
}
}
createKennel
Response
Returns a KennelSchema!
Arguments
| Name | Description |
|---|---|
input - KennelCreateSchema!
|
Example
Query
mutation CreateKennel($input: KennelCreateSchema!) {
createKennel(input: $input) {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": KennelCreateSchema}
Response
{
"data": {
"createKennel": {
"id": "4",
"order": 987,
"kennelType": "xyz789",
"description": "abc123",
"species": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createLink
Response
Returns a LinkSchema!
Arguments
| Name | Description |
|---|---|
input - LinkCreateSchema!
|
Example
Query
mutation CreateLink($input: LinkCreateSchema!) {
createLink(input: $input) {
id
url
description
linkType
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": LinkCreateSchema}
Response
{
"data": {
"createLink": {
"id": 4,
"url": "abc123",
"description": "abc123",
"linkType": "IDEXX_XRAY",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createMiscNote
Response
Returns a MiscNoteSchema!
Arguments
| Name | Description |
|---|---|
input - MiscNoteCreateSchema!
|
Example
Query
mutation CreateMiscNote($input: MiscNoteCreateSchema!) {
createMiscNote(input: $input) {
id
description
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": MiscNoteCreateSchema}
Response
{
"data": {
"createMiscNote": {
"id": "4",
"description": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createOngoingDiagnosis
Response
Returns an OngoingDiagnosisSchema!
Arguments
| Name | Description |
|---|---|
input - OngoingDiagnosisCreateSchema!
|
Example
Query
mutation CreateOngoingDiagnosis($input: OngoingDiagnosisCreateSchema!) {
createOngoingDiagnosis(input: $input) {
id
creatorId
patientId
diagnosis {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
name
source
dischargeDocumentIds
}
diagnosisDate
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": OngoingDiagnosisCreateSchema}
Response
{
"data": {
"createOngoingDiagnosis": {
"id": "4",
"creatorId": 4,
"patientId": 4,
"diagnosis": DiagnosisEntrySchema,
"diagnosisDate": datetime,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createOrderNoteFromEstimate
Response
Returns an OrderNoteSchema!
Arguments
| Name | Description |
|---|---|
input - CreateNoteFromEstimateInput!
|
Example
Query
mutation CreateOrderNoteFromEstimate($input: CreateNoteFromEstimateInput!) {
createOrderNoteFromEstimate(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
notes
}
}
Variables
{"input": CreateNoteFromEstimateInput}
Response
{
"data": {
"createOrderNoteFromEstimate": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": "4",
"creatorUid": "4",
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"notes": "abc123"
}
}
}
createOrderWithVendor
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation CreateOrderWithVendor($id: ID!) {
createOrderWithVendor(id: $id) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"createOrderWithVendor": {
"idexxUiUrl": "xyz789",
"orderPdfUrl": "abc123",
"resultPdfUrl": "xyz789",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "abc123",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "abc123",
"id": "4",
"treatmentId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"patientId": 4,
"instructions": "xyz789",
"isStaff": false,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
}
}
createPatientDiagram
Response
Returns a PatientDiagramSchema!
Arguments
| Name | Description |
|---|---|
input - PatientDiagramCreateSchema!
|
Example
Query
mutation CreatePatientDiagram($input: PatientDiagramCreateSchema!) {
createPatientDiagram(input: $input) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
title
species
type
mediaId
nectarDefault
creatorId
createdAt
updatedAt
deletedAt
}
}
Variables
{"input": PatientDiagramCreateSchema}
Response
{
"data": {
"createPatientDiagram": {
"media": MediaSchema,
"id": 4,
"title": "abc123",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": "4",
"nectarDefault": true,
"creatorId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
}
}
createProvider
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CreateProviderInput!
|
Example
Query
mutation CreateProvider($input: CreateProviderInput!) {
createProvider(input: $input)
}
Variables
{"input": CreateProviderInput}
Response
{"data": {"createProvider": true}}
createPurchaseOrder
Response
Returns a PurchaseOrderSchema!
Arguments
| Name | Description |
|---|---|
input - PurchaseOrderCreateSchema!
|
Example
Query
mutation CreatePurchaseOrder($input: PurchaseOrderCreateSchema!) {
createPurchaseOrder(input: $input) {
id
vetcoveId
creatorUid
poNumber
subtotal
tax
shipping
total
vendorId
items {
id
name
sku
unitMeasurement
quantity
treatmentId
locationId
vetcoveItemId
unitPrice
listPrice
totalPrice
units
isLinked
packType
availabilityCode
availabilityText
manufacturerName
deletedAt
receivedAt
cancelled
expiredAt
inventoryItemId
lotId
serialNo
ndcNumber
}
orderPlacementTime
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": PurchaseOrderCreateSchema}
Response
{
"data": {
"createPurchaseOrder": {
"id": "4",
"vetcoveId": 123,
"creatorUid": 4,
"poNumber": "abc123",
"subtotal": 123,
"tax": 987,
"shipping": 123,
"total": 123,
"vendorId": 4,
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createReminder
Response
Returns a ReminderSchema!
Arguments
| Name | Description |
|---|---|
input - ReminderCreateSchema!
|
Example
Query
mutation CreateReminder($input: ReminderCreateSchema!) {
createReminder(input: $input) {
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
vaccine {
media {
...MediaSchemaFragment
}
vaccineId
status
patientId
creatorUid
item {
...VaccineItemSchemaFragment
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
isEmailable
isSmsable
reminderId
status
patientId
refId
notes
type
creatorUid
invoiceId
dueDate
createdAt
updatedAt
}
}
Variables
{"input": ReminderCreateSchema}
Response
{
"data": {
"createReminder": {
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": false,
"isSmsable": true,
"reminderId": 4,
"status": "ACTIVE",
"patientId": "4",
"refId": "4",
"notes": "abc123",
"type": "TREATMENT",
"creatorUid": "4",
"invoiceId": 4,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createRxScript
Response
Returns a RxScriptSchema!
Arguments
| Name | Description |
|---|---|
input - RxScriptCreateSchema!
|
Example
Query
mutation CreateRxScript($input: RxScriptCreateSchema!) {
createRxScript(input: $input) {
originalRxScript {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
treatmentobj {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
Variables
{"input": RxScriptCreateSchema}
Response
{
"data": {
"createRxScript": {
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": 4,
"patientId": "4",
"creatorUid": "4",
"filledById": 4,
"clientId": "4",
"refId": 4,
"originalRefId": "4",
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": "4",
"treatmentInstanceId": "4",
"treatment": "abc123",
"totalDosage": Decimal,
"duration": 123,
"durationUnit": "MINUTES",
"customDoseUnit": "abc123",
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"refills": 987,
"instructions": "xyz789",
"voided": true,
"voidReason": "abc123",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
}
}
createScheduledEvents
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
input - CreateScheduledEventsSchema!
|
Example
Query
mutation CreateScheduledEvents($input: CreateScheduledEventsSchema!) {
createScheduledEvents(input: $input) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": CreateScheduledEventsSchema}
Response
{
"data": {
"createScheduledEvents": {
"id": 4,
"patientId": "4",
"clientId": "4",
"providerId": 4,
"techUid": "4",
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createSmsTemplate
Response
Returns an SMSTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SMSTemplateCreateSchema!
|
Example
Query
mutation CreateSmsTemplate($input: SMSTemplateCreateSchema!) {
createSmsTemplate(input: $input) {
availableVariables
id
name
description
templateKey
body
type
linkedFormIds
createdAt
updatedAt
deletedAt
}
}
Variables
{"input": SMSTemplateCreateSchema}
Response
{
"data": {
"createSmsTemplate": {
"availableVariables": {},
"id": "4",
"name": "abc123",
"description": "xyz789",
"templateKey": "abc123",
"body": "abc123",
"type": "AUTOMATED",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
}
}
createSoapFromEstimate
Response
Returns a SoapSchema!
Arguments
| Name | Description |
|---|---|
input - CreateNoteFromEstimateInput!
|
Example
Query
mutation CreateSoapFromEstimate($input: CreateNoteFromEstimateInput!) {
createSoapFromEstimate(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"input": CreateNoteFromEstimateInput}
Response
{
"data": {
"createSoapFromEstimate": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": "4",
"vetUid": 4,
"voiceNoteId": 4,
"details": "xyz789",
"subjective": "xyz789",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "abc123",
"forms": ["4"],
"voiceNoteApprovedSignature": "xyz789"
}
}
}
createSoapTemplate
Response
Returns a SoapTemplateSchema
Arguments
| Name | Description |
|---|---|
input - SoapTemplateCreateSchema!
|
Example
Query
mutation CreateSoapTemplate($input: SoapTemplateCreateSchema!) {
createSoapTemplate(input: $input) {
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SoapTemplateCreateSchema}
Response
{
"data": {
"createSoapTemplate": {
"appointmentType": AppointmentTypeResolveSchema,
"id": "4",
"creatorId": 4,
"name": "xyz789",
"species": "xyz789",
"appointmentTypeId": 4,
"isDeleted": false,
"favoritedBy": [4],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createSpecialCareNote
Response
Returns a SpecialCareNoteSchema!
Arguments
| Name | Description |
|---|---|
input - SpecialCareNoteCreateSchema!
|
Example
Query
mutation CreateSpecialCareNote($input: SpecialCareNoteCreateSchema!) {
createSpecialCareNote(input: $input) {
createdByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
updatedByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
resource {
... on PatientSchema {
...PatientSchemaFragment
}
... on ClinicUserSchema {
...ClinicUserSchemaFragment
}
}
id
resourceId
resourceType
createdBy
updatedBy
note
noteType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": SpecialCareNoteCreateSchema}
Response
{
"data": {
"createSpecialCareNote": {
"createdByUser": ClinicUserSchema,
"updatedByUser": ClinicUserSchema,
"resource": PatientSchema,
"id": "4",
"resourceId": 4,
"resourceType": "PATIENT",
"createdBy": 4,
"updatedBy": 4,
"note": "xyz789",
"noteType": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createSpecies
Response
Returns a SpeciesSchema!
Arguments
| Name | Description |
|---|---|
input - SpeciesCreateSchema!
|
Example
Query
mutation CreateSpecies($input: SpeciesCreateSchema!) {
createSpecies(input: $input) {
id
species
imageData
createdAt
updatedAt
custom
}
}
Variables
{"input": SpeciesCreateSchema}
Response
{
"data": {
"createSpecies": {
"id": "4",
"species": "abc123",
"imageData": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"custom": true
}
}
}
createSubscription
Response
Returns a SubscriptionSchema!
Arguments
| Name | Description |
|---|---|
input - CreateSubscriptionInput!
|
Example
Query
mutation CreateSubscription($input: CreateSubscriptionInput!) {
createSubscription(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"input": CreateSubscriptionInput}
Response
{
"data": {
"createSubscription": {
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "abc123",
"accountId": "xyz789",
"customerId": "xyz789",
"status": "ACTIVE",
"price": 123,
"currency": "AUD",
"intervalUnit": "abc123",
"intervalCount": 987,
"paymentMethodId": "xyz789",
"platformFeeAmount": 987,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createSurgeryFromEstimate
Response
Returns a SurgerySchema!
Arguments
| Name | Description |
|---|---|
input - CreateNoteFromEstimateInput!
|
Example
Query
mutation CreateSurgeryFromEstimate($input: CreateNoteFromEstimateInput!) {
createSurgeryFromEstimate(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
procedure
preop {
asaScore
notes
}
intraop {
anesthesiaStartAt
anesthesiaEndAt
procedureStartAt
procedureEndAt
medicationNotes
procedureNotes
}
postop {
numOxygenationMin
isEttExtubated
notes
}
recordedSurgeryVitals {
values {
...SurgeryVitalValueSchemaFragment
}
createdAt
}
}
}
Variables
{"input": CreateNoteFromEstimateInput}
Response
{
"data": {
"createSurgeryFromEstimate": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": 4,
"creatorUid": "4",
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"procedure": "abc123",
"preop": PreopSchema,
"intraop": IntraopSchema,
"postop": PostopSchema,
"recordedSurgeryVitals": [
RecordedSurgeryVitalSchema
]
}
}
}
createSurgeryTemplate
Response
Returns a SurgeryTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SurgeryTemplateCreateSchema!
|
Example
Query
mutation CreateSurgeryTemplate($input: SurgeryTemplateCreateSchema!) {
createSurgeryTemplate(input: $input) {
id
name
creatorId
species
isDeleted
favoritedBy
surgeryTemplateData {
treatments {
...TreatmentSchemaFragment
}
procedure
preopNotes
intraopMedicationNotes
intraopProcedureNotes
postopNotes
treatmentIds
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SurgeryTemplateCreateSchema}
Response
{
"data": {
"createSurgeryTemplate": {
"id": "4",
"name": "xyz789",
"creatorId": "4",
"species": "abc123",
"isDeleted": false,
"favoritedBy": ["4"],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createTask
Response
Returns a TaskSchema!
Arguments
| Name | Description |
|---|---|
input - TaskCreateSchema!
|
Example
Query
mutation CreateTask($input: TaskCreateSchema!) {
createTask(input: $input) {
id
patientId
clientId
creatorId
assignedById
assigneeId
taskType
priority
status
description
dueAt
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": TaskCreateSchema}
Response
{
"data": {
"createTask": {
"id": "4",
"patientId": "4",
"clientId": "4",
"creatorId": "4",
"assignedById": 4,
"assigneeId": "4",
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "abc123",
"dueAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createTransaction
Response
Returns a TransactionSchema!
Arguments
| Name | Description |
|---|---|
input - TransactionCreateSchema!
|
Example
Query
mutation CreateTransaction($input: TransactionCreateSchema!) {
createTransaction(input: $input) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"input": TransactionCreateSchema}
Response
{
"data": {
"createTransaction": {
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": true,
"transactionId": 4,
"familyId": 4,
"clientId": "4",
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": 4,
"voidedTransactionId": 4,
"otherInvoiceIds": [4],
"otherTransactionIds": ["4"],
"partialVoid": true,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "abc123",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": false
}
}
}
createTreatmentPlan
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
input - TreatmentPlanCreateSchema!
|
Example
Query
mutation CreateTreatmentPlan($input: TreatmentPlanCreateSchema!) {
createTreatmentPlan(input: $input) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": TreatmentPlanCreateSchema}
Response
{
"data": {
"createTreatmentPlan": {
"id": 4,
"patientId": 4,
"clientId": "4",
"providerId": "4",
"techUid": 4,
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "xyz789",
"status": "ONGOING",
"originId": 4,
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createTreatmentPlanFromMedicalNote
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
input - CreateTreatmentPlanFromMedicalNoteSchema!
|
Example
Query
mutation CreateTreatmentPlanFromMedicalNote($input: CreateTreatmentPlanFromMedicalNoteSchema!) {
createTreatmentPlanFromMedicalNote(input: $input) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": CreateTreatmentPlanFromMedicalNoteSchema}
Response
{
"data": {
"createTreatmentPlanFromMedicalNote": {
"id": "4",
"patientId": "4",
"clientId": 4,
"providerId": "4",
"techUid": "4",
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createVaccine
Response
Returns a VaccineSchema!
Arguments
| Name | Description |
|---|---|
input - VaccineCreateSchema!
|
Example
Query
mutation CreateVaccine($input: VaccineCreateSchema!) {
createVaccine(input: $input) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
vaccineId
status
patientId
creatorUid
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
}
Variables
{"input": VaccineCreateSchema}
Response
{
"data": {
"createVaccine": {
"media": MediaSchema,
"vaccineId": 4,
"status": "OPEN",
"patientId": 4,
"creatorUid": 4,
"item": VaccineItemSchema,
"approved": true,
"declined": true,
"vaccinationDate": "xyz789",
"expDate": "abc123",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"invoiceId": 4,
"clientId": "4",
"tagNumber": "xyz789",
"previousTagNumber": "xyz789",
"approverId": 4,
"approverName": "abc123",
"approverLicense": "abc123",
"signature": "abc123",
"mediaRef": "4",
"originalVaccineId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
createVisitNoteFromEstimate
Response
Returns a VisitNoteSchema!
Arguments
| Name | Description |
|---|---|
input - CreateNoteFromEstimateInput!
|
Example
Query
mutation CreateVisitNoteFromEstimate($input: CreateNoteFromEstimateInput!) {
createVisitNoteFromEstimate(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
voiceNoteId
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
}
}
Variables
{"input": CreateNoteFromEstimateInput}
Response
{
"data": {
"createVisitNoteFromEstimate": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": 4,
"providerId": 4,
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"voiceNoteId": 4,
"notes": "xyz789",
"details": "xyz789",
"recs": "xyz789",
"assessment": SoapAssessmentSchema
}
}
}
createVisitNoteTemplate
Response
Returns a VisitNoteTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - VisitNoteTemplateCreateSchema!
|
Example
Query
mutation CreateVisitNoteTemplate($input: VisitNoteTemplateCreateSchema!) {
createVisitNoteTemplate(input: $input) {
id
name
creatorId
species
isDeleted
favoritedBy
appointmentTypeId
visitNoteTemplateData {
treatments {
...TreatmentSchemaFragment
}
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
}
createdAt
updatedAt
}
}
Variables
{"input": VisitNoteTemplateCreateSchema}
Response
{
"data": {
"createVisitNoteTemplate": {
"id": 4,
"name": "xyz789",
"creatorId": 4,
"species": "abc123",
"isDeleted": false,
"favoritedBy": ["4"],
"appointmentTypeId": 4,
"visitNoteTemplateData": VisitNoteTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createVoiceNote
Response
Returns a VoiceNoteSchema!
Arguments
| Name | Description |
|---|---|
input - VoiceNoteCreateSchema!
|
Example
Query
mutation CreateVoiceNote($input: VoiceNoteCreateSchema!) {
createVoiceNote(input: $input) {
creatorId
id
soapId
patientId
convertedSoapNote
recordings {
mimeType
mediaUrl
transcribedText
mediaId
createdAt
}
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": VoiceNoteCreateSchema}
Response
{
"data": {
"createVoiceNote": {
"creatorId": "4",
"id": 4,
"soapId": "4",
"patientId": 4,
"convertedSoapNote": "xyz789",
"recordings": [RecordingSchema],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
createWorkflowAutomation
Response
Returns a WorkflowAutomation!
Arguments
| Name | Description |
|---|---|
input - WorkflowAutomationCreateInput!
|
Example
Query
mutation CreateWorkflowAutomation($input: WorkflowAutomationCreateInput!) {
createWorkflowAutomation(input: $input) {
pendingExecutionsCount
id
name
description
status
createdBy
clinicId
triggers {
type
operator
conditions {
...WorkflowAutomationConditionsFragment
}
}
triggerLogic
actions {
type
timing {
...ActionTimingFragment
}
config {
...WorkflowAutomationActionConfigFragment
}
}
instanceId
createdAt
updatedAt
updatedBy
}
}
Variables
{"input": WorkflowAutomationCreateInput}
Response
{
"data": {
"createWorkflowAutomation": {
"pendingExecutionsCount": 123,
"id": 4,
"name": "xyz789",
"description": "xyz789",
"status": "ACTIVE",
"createdBy": "4",
"clinicId": 4,
"triggers": [WorkflowAutomationTrigger],
"triggerLogic": "AND",
"actions": [WorkflowAutomationAction],
"instanceId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"updatedBy": "4"
}
}
}
createXrayOrderWithVendor
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation CreateXrayOrderWithVendor($id: ID!) {
createXrayOrderWithVendor(id: $id) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"createXrayOrderWithVendor": {
"resultUrl": "xyz789",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": 4,
"treatmentId": 4,
"patientId": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": 4,
"isStaff": true,
"providerId": "4",
"status": "NEW",
"notes": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
declineEstimate
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
input - EstimateDeclineSchema!
|
Example
Query
mutation DeclineEstimate($input: EstimateDeclineSchema!) {
declineEstimate(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimateDeclineSchema}
Response
{
"data": {
"declineEstimate": {
"soap": SoapSchema,
"estimateId": "4",
"status": "OPEN",
"patientId": 4,
"creatorUid": "4",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 123,
"maxSubtotal": 123,
"isTaxExempt": true,
"minTax": 123,
"maxTax": 987,
"minPstTax": 987,
"maxPstTax": 987,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 987,
"minTotal": 123,
"maxTotal": 123,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": 4,
"otherApproverName": "abc123",
"media": [MediaSchema],
"title": "abc123",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteAddendum
deleteAppointment
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
appointmentId - ID!
|
|
updateRecurringMode - UpdateRecurringMode
|
Default = null |
Example
Query
mutation DeleteAppointment(
$appointmentId: ID!,
$updateRecurringMode: UpdateRecurringMode
) {
deleteAppointment(
appointmentId: $appointmentId,
updateRecurringMode: $updateRecurringMode
)
}
Variables
{"appointmentId": 4, "updateRecurringMode": "null"}
Response
{"data": {"deleteAppointment": "abc123"}}
deleteAppointmentCheckout
deleteAppointmentType
deleteBreed
deleteBundle
deleteColor
deleteCommissionSettings
deleteDiagnosis
deleteDischargeDocument
deleteEmailTemplate
deleteEstimate
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
input - EstimateDeleteSchema!
|
Example
Query
mutation DeleteEstimate($input: EstimateDeleteSchema!) {
deleteEstimate(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimateDeleteSchema}
Response
{
"data": {
"deleteEstimate": {
"soap": SoapSchema,
"estimateId": 4,
"status": "OPEN",
"patientId": 4,
"creatorUid": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": 4,
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 987,
"maxSubtotal": 123,
"isTaxExempt": true,
"minTax": 987,
"maxTax": 123,
"minPstTax": 987,
"maxPstTax": 123,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"minTotal": 123,
"maxTotal": 987,
"approved": false,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": 4,
"otherApproverName": "xyz789",
"media": [MediaSchema],
"title": "abc123",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteForm
deleteFormSubmission
deleteFreemium
deleteGroupDiscount
deleteInventoryItem
deleteInventoryTransaction
deleteInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceDeleteSchema!
|
Example
Query
mutation DeleteInvoice($input: InvoiceDeleteSchema!) {
deleteInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceDeleteSchema}
Response
{
"data": {
"deleteInvoice": {
"invoiceId": "4",
"patientId": 4,
"status": "OPEN",
"clientId": "4",
"creatorUid": "4",
"voidedUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"estimateId": 4,
"parentInvoiceId": "4",
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"total": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": false,
"storeCreditApplied": 123,
"storeCreditManuallySet": false,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": true,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 123,
"outstandingBalance": 123,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
}
}
deleteKennel
deleteLab
deleteLink
deleteLocation
deleteMedia
Response
Returns a MediaSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeleteMedia($id: ID!) {
deleteMedia(id: $id) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteMedia": {
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": 4,
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "xyz789",
"deletedAt": "xyz789",
"title": "abc123",
"description": "abc123",
"summaryGeneratedByAi": true,
"transcript": "abc123",
"key": "xyz789",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
deleteMiscNote
deleteOngoingDiagnosis
deleteOrderNote
deletePatientDiagram
deletePatientVitals
deletePaymentMethod
deletePurchaseOrder
deleteReminder
Response
Returns a ReminderSchema!
Arguments
| Name | Description |
|---|---|
input - ReminderDeleteSchema!
|
Example
Query
mutation DeleteReminder($input: ReminderDeleteSchema!) {
deleteReminder(input: $input) {
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
vaccine {
media {
...MediaSchemaFragment
}
vaccineId
status
patientId
creatorUid
item {
...VaccineItemSchemaFragment
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
isEmailable
isSmsable
reminderId
status
patientId
refId
notes
type
creatorUid
invoiceId
dueDate
createdAt
updatedAt
}
}
Variables
{"input": ReminderDeleteSchema}
Response
{
"data": {
"deleteReminder": {
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": false,
"isSmsable": true,
"reminderId": "4",
"status": "ACTIVE",
"patientId": 4,
"refId": "4",
"notes": "abc123",
"type": "TREATMENT",
"creatorUid": 4,
"invoiceId": 4,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteRole
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RoleDeleteSchema!
|
Example
Query
mutation DeleteRole($input: RoleDeleteSchema!) {
deleteRole(input: $input)
}
Variables
{"input": RoleDeleteSchema}
Response
{"data": {"deleteRole": true}}
deleteSchedule
deleteSmsTemplate
deleteSoapPatientDiagram
Response
Returns a SoapSchema!
Example
Query
mutation DeleteSoapPatientDiagram(
$soapId: ID!,
$patientDiagramId: ID!
) {
deleteSoapPatientDiagram(
soapId: $soapId,
patientDiagramId: $patientDiagramId
) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"soapId": 4, "patientDiagramId": 4}
Response
{
"data": {
"deleteSoapPatientDiagram": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": 4,
"providerId": 4,
"creatorUid": "4",
"techUid": "4",
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": 4,
"vetUid": "4",
"voiceNoteId": 4,
"details": "abc123",
"subjective": "xyz789",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "xyz789",
"forms": [4],
"voiceNoteApprovedSignature": "xyz789"
}
}
}
deleteSoapTemplate
Response
Returns a SoapTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeleteSoapTemplate($id: ID!) {
deleteSoapTemplate(id: $id) {
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteSoapTemplate": {
"appointmentType": AppointmentTypeResolveSchema,
"id": "4",
"creatorId": 4,
"name": "xyz789",
"species": "abc123",
"appointmentTypeId": 4,
"isDeleted": true,
"favoritedBy": ["4"],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteSpecialCareNote
deleteSpecies
deleteSurgery
deleteSurgeryPatientDiagram
Response
Returns a SurgerySchema!
Example
Query
mutation DeleteSurgeryPatientDiagram(
$surgeryId: ID!,
$patientDiagramId: ID!
) {
deleteSurgeryPatientDiagram(
surgeryId: $surgeryId,
patientDiagramId: $patientDiagramId
) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
procedure
preop {
asaScore
notes
}
intraop {
anesthesiaStartAt
anesthesiaEndAt
procedureStartAt
procedureEndAt
medicationNotes
procedureNotes
}
postop {
numOxygenationMin
isEttExtubated
notes
}
recordedSurgeryVitals {
values {
...SurgeryVitalValueSchemaFragment
}
createdAt
}
}
}
Variables
{"surgeryId": 4, "patientDiagramId": "4"}
Response
{
"data": {
"deleteSurgeryPatientDiagram": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": "4",
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"procedure": "xyz789",
"preop": PreopSchema,
"intraop": IntraopSchema,
"postop": PostopSchema,
"recordedSurgeryVitals": [
RecordedSurgeryVitalSchema
]
}
}
}
deleteSurgeryTemplate
Response
Returns a SurgeryTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeleteSurgeryTemplate($id: ID!) {
deleteSurgeryTemplate(id: $id) {
id
name
creatorId
species
isDeleted
favoritedBy
surgeryTemplateData {
treatments {
...TreatmentSchemaFragment
}
procedure
preopNotes
intraopMedicationNotes
intraopProcedureNotes
postopNotes
treatmentIds
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteSurgeryTemplate": {
"id": 4,
"name": "xyz789",
"creatorId": 4,
"species": "xyz789",
"isDeleted": false,
"favoritedBy": ["4"],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteSurgeryVital
deleteTask
Response
Returns a TaskSchema!
Arguments
| Name | Description |
|---|---|
input - TaskDeleteSchema!
|
Example
Query
mutation DeleteTask($input: TaskDeleteSchema!) {
deleteTask(input: $input) {
id
patientId
clientId
creatorId
assignedById
assigneeId
taskType
priority
status
description
dueAt
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": TaskDeleteSchema}
Response
{
"data": {
"deleteTask": {
"id": "4",
"patientId": "4",
"clientId": 4,
"creatorId": "4",
"assignedById": "4",
"assigneeId": 4,
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "abc123",
"dueAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteTreatment
Response
Returns a Boolean!
Example
Query
mutation DeleteTreatment(
$treatmentId: ID!,
$deleteReminders: Boolean!
) {
deleteTreatment(
treatmentId: $treatmentId,
deleteReminders: $deleteReminders
)
}
Variables
{
"treatmentId": "4",
"deleteReminders": true
}
Response
{"data": {"deleteTreatment": false}}
deleteTreatmentPlan
deleteVendor
deleteVisitNote
deleteVisitNotePatientDiagram
Response
Returns a VisitNoteSchema!
Example
Query
mutation DeleteVisitNotePatientDiagram(
$visitNoteId: ID!,
$patientDiagramId: ID!
) {
deleteVisitNotePatientDiagram(
visitNoteId: $visitNoteId,
patientDiagramId: $patientDiagramId
) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
voiceNoteId
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
}
}
Variables
{"visitNoteId": "4", "patientDiagramId": 4}
Response
{
"data": {
"deleteVisitNotePatientDiagram": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": 4,
"techUid": "4",
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"voiceNoteId": 4,
"notes": "abc123",
"details": "abc123",
"recs": "abc123",
"assessment": SoapAssessmentSchema
}
}
}
deleteVisitNoteTemplate
Response
Returns a VisitNoteTemplateSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation DeleteVisitNoteTemplate($id: ID!) {
deleteVisitNoteTemplate(id: $id) {
id
name
creatorId
species
isDeleted
favoritedBy
appointmentTypeId
visitNoteTemplateData {
treatments {
...TreatmentSchemaFragment
}
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
}
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteVisitNoteTemplate": {
"id": "4",
"name": "abc123",
"creatorId": "4",
"species": "xyz789",
"isDeleted": true,
"favoritedBy": ["4"],
"appointmentTypeId": 4,
"visitNoteTemplateData": VisitNoteTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
deleteVoiceNote
deleteWorkflowAutomation
Example
Query
mutation DeleteWorkflowAutomation($workflowAutomationId: ID!) {
deleteWorkflowAutomation(workflowAutomationId: $workflowAutomationId)
}
Variables
{"workflowAutomationId": 4}
Response
{"data": {"deleteWorkflowAutomation": null}}
deleteXray
disconnectAntechV6
Response
Returns a SettingsSchema!
Example
Query
mutation DisconnectAntechV6 {
disconnectAntechV6 {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"disconnectAntechV6": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "abc123",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "xyz789",
"state": "abc123",
"country": "abc123",
"zipCode": "xyz789",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": false,
"tilledAccountId": "abc123",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": false,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
}
}
disconnectEllie
Response
Returns a SettingsSchema!
Example
Query
mutation DisconnectEllie {
disconnectEllie {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"disconnectEllie": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"country": "xyz789",
"zipCode": "xyz789",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 987,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 123.45,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["xyz789"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "abc123"
}
}
}
disconnectHl7i
Response
Returns a SettingsSchema!
Arguments
| Name | Description |
|---|---|
input - Hl7iDisconnectSchema!
|
Example
Query
mutation DisconnectHl7i($input: Hl7iDisconnectSchema!) {
disconnectHl7i(input: $input) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{"input": Hl7iDisconnectSchema}
Response
{
"data": {
"disconnectHl7i": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "abc123",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "xyz789",
"state": "abc123",
"country": "abc123",
"zipCode": "abc123",
"name": "abc123",
"status": "OPEN",
"email": "xyz789",
"phone": "abc123",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 123.45,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "abc123"
}
}
}
disconnectIdexx
Response
Returns a SettingsSchema!
Example
Query
mutation DisconnectIdexx {
disconnectIdexx {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"disconnectIdexx": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "abc123",
"state": "abc123",
"country": "xyz789",
"zipCode": "abc123",
"name": "xyz789",
"status": "OPEN",
"email": "xyz789",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "xyz789",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 987,
"taxRate": 123.45,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": true,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["xyz789"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": false,
"ipRestrictionEnabled": true,
"clinicIpAddress": "abc123"
}
}
}
disconnectIdexxWebpacs
Response
Returns a SettingsSchema!
Example
Query
mutation DisconnectIdexxWebpacs {
disconnectIdexxWebpacs {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"disconnectIdexxWebpacs": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "abc123",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"country": "abc123",
"zipCode": "abc123",
"name": "xyz789",
"status": "OPEN",
"email": "xyz789",
"phone": "xyz789",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": "4",
"vetcoveConnected": false,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 987,
"appAutolockMinutes": 987,
"vitalsAutolockHours": 123,
"taxRate": 123.45,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": false,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": true,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "abc123"
}
}
}
disconnectZoetis
Response
Returns a SettingsSchema!
Example
Query
mutation DisconnectZoetis {
disconnectZoetis {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"disconnectZoetis": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "xyz789",
"state": "abc123",
"country": "xyz789",
"zipCode": "xyz789",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "abc123",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": true,
"tilledAccountId": "abc123",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 987,
"vitalsAutolockHours": 987,
"taxRate": 123.45,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": false,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "abc123",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["xyz789"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
}
}
duplicateEmailTemplate
Response
Returns an EmailTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - EmailTemplateDuplicateSchema!
|
Example
Query
mutation DuplicateEmailTemplate($input: EmailTemplateDuplicateSchema!) {
duplicateEmailTemplate(input: $input) {
postFooter
availableVariables
id
name
description
key
templateKey
enabled
type
replyTo
subject
body
bodyJson
footer
footerJson
linkedFormIds
createdAt
updatedAt
}
}
Variables
{"input": EmailTemplateDuplicateSchema}
Response
{
"data": {
"duplicateEmailTemplate": {
"postFooter": "xyz789",
"availableVariables": {},
"id": 4,
"name": "xyz789",
"description": "xyz789",
"key": "xyz789",
"templateKey": "xyz789",
"enabled": false,
"type": "SYSTEM",
"replyTo": "xyz789",
"subject": "xyz789",
"body": "xyz789",
"bodyJson": "abc123",
"footer": "xyz789",
"footerJson": "xyz789",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
duplicateForm
Response
Returns a FormSchema!
Arguments
| Name | Description |
|---|---|
input - FormDuplicateSchema!
|
Example
Query
mutation DuplicateForm($input: FormDuplicateSchema!) {
duplicateForm(input: $input) {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": FormDuplicateSchema}
Response
{
"data": {
"duplicateForm": {
"id": "4",
"title": "abc123",
"description": "xyz789",
"uiSchema": {},
"baseSchema": {},
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
duplicateInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceDuplicateSchema!
|
Example
Query
mutation DuplicateInvoice($input: InvoiceDuplicateSchema!) {
duplicateInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceDuplicateSchema}
Response
{
"data": {
"duplicateInvoice": {
"invoiceId": 4,
"patientId": "4",
"status": "OPEN",
"clientId": "4",
"creatorUid": "4",
"voidedUid": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": true,
"tax": 123,
"taxRate": 987.65,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 987,
"total": 123,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": false,
"storeCreditApplied": 987,
"storeCreditManuallySet": false,
"voidedAt": datetime,
"notes": "xyz789",
"invoicedAt": datetime,
"title": "abc123",
"isInterestCharge": false,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 123,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 123,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
}
}
editClient
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
input - ClientUpdateSchema!
|
Example
Query
mutation EditClient($input: ClientUpdateSchema!) {
editClient(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": ClientUpdateSchema}
Response
{
"data": {
"editClient": {
"profilePicture": MediaSchema,
"id": "4",
"firstName": "xyz789",
"lastName": "abc123",
"emailH": "xyz789",
"emailW": "abc123",
"phoneH": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": false,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
editPatient
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
input - PatientUpdateSchema!
|
Example
Query
mutation EditPatient($input: PatientUpdateSchema!) {
editPatient(input: $input) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"input": PatientUpdateSchema}
Response
{
"data": {
"editPatient": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "xyz789",
"familyId": "4",
"contactUid": 4,
"firstName": "abc123",
"status": "ACTIVE",
"species": "abc123",
"lastName": "xyz789",
"breed": "xyz789",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 987.65,
"gender": "MALE",
"spayNeuter": false,
"photoUrl": "xyz789",
"warnings": "abc123",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
enableMultiLocation
Response
Returns a Void
Example
Query
mutation EnableMultiLocation {
enableMultiLocation
}
Response
{"data": {"enableMultiLocation": null}}
fillRxScript
Response
Returns a FillRxScriptResponseSchema!
Arguments
| Name | Description |
|---|---|
input - RxScriptFillSchema!
|
Example
Query
mutation FillRxScript($input: RxScriptFillSchema!) {
fillRxScript(input: $input) {
rxScript {
originalRxScript {
...RxScriptOriginalSchemaFragment
}
mostRecentRefill {
...RxScriptOriginalSchemaFragment
}
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
invoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
}
Variables
{"input": RxScriptFillSchema}
Response
{
"data": {
"fillRxScript": {
"rxScript": RxScriptSchema,
"invoice": InvoiceSchema
}
}
}
generateMediaSummary
Response
Returns a MediaSummaryResponse!
Arguments
| Name | Description |
|---|---|
input - MediaSummaryRequest!
|
Example
Query
mutation GenerateMediaSummary($input: MediaSummaryRequest!) {
generateMediaSummary(input: $input) {
summary
mediaId
}
}
Variables
{"input": MediaSummaryRequest}
Response
{
"data": {
"generateMediaSummary": {
"summary": "abc123",
"mediaId": "4"
}
}
}
generateSoap
Response
Returns a SoapResponse!
Arguments
| Name | Description |
|---|---|
input - GenerateSoapRequest!
|
Example
Query
mutation GenerateSoap($input: GenerateSoapRequest!) {
generateSoap(input: $input) {
convertedSoapNote {
subjective
objective {
...SoapObjectiveFragment
}
assessment {
...SoapAssessmentFragment
}
plan
}
content
prescribedTreatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
}
}
Variables
{"input": GenerateSoapRequest}
Response
{
"data": {
"generateSoap": {
"convertedSoapNote": Soap,
"content": "xyz789",
"prescribedTreatments": [PrescribedTreatmentSchema]
}
}
}
getVoiceToken
Response
Returns a VoiceTokenSchema!
Example
Query
mutation GetVoiceToken {
getVoiceToken {
token
}
}
Response
{
"data": {
"getVoiceToken": {"token": "xyz789"}
}
}
importPatientBodyMap
Response
Returns a SoapSchemaSurgerySchemaVisitNoteSchema!
Example
Query
mutation ImportPatientBodyMap(
$patientId: ID!,
$noteId: ID!,
$noteType: NoteType!
) {
importPatientBodyMap(
patientId: $patientId,
noteId: $noteId,
noteType: $noteType
) {
... on SoapSchema {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
... on SurgerySchema {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
... on VisitNoteSchema {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
}
}
Variables
{"patientId": 4, "noteId": 4, "noteType": "SOAP"}
Response
{"data": {"importPatientBodyMap": SoapSchema}}
importPatientDiagramsFromMostRecentNote
Response
Returns a SoapSchemaSurgerySchemaVisitNoteSchema!
Example
Query
mutation ImportPatientDiagramsFromMostRecentNote(
$patientId: ID!,
$noteId: ID!,
$noteType: NoteType!
) {
importPatientDiagramsFromMostRecentNote(
patientId: $patientId,
noteId: $noteId,
noteType: $noteType
) {
... on SoapSchema {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
... on SurgerySchema {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
... on VisitNoteSchema {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
}
}
Variables
{
"patientId": 4,
"noteId": "4",
"noteType": "SOAP"
}
Response
{
"data": {
"importPatientDiagramsFromMostRecentNote": SoapSchema
}
}
indexPatient
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
input - PatientIndexSchema!
|
Example
Query
mutation IndexPatient($input: PatientIndexSchema!) {
indexPatient(input: $input) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"input": PatientIndexSchema}
Response
{
"data": {
"indexPatient": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": false,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "abc123",
"familyId": 4,
"contactUid": "4",
"firstName": "xyz789",
"status": "ACTIVE",
"species": "abc123",
"lastName": "xyz789",
"breed": "xyz789",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "abc123",
"weightLbs": 987.65,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": true,
"photoUrl": "xyz789",
"warnings": "abc123",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
labRefetchFromVendor
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation LabRefetchFromVendor($id: ID!) {
labRefetchFromVendor(id: $id) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"labRefetchFromVendor": {
"idexxUiUrl": "abc123",
"orderPdfUrl": "abc123",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "abc123",
"notes": "xyz789",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "abc123",
"id": 4,
"treatmentId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": [4],
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"patientId": 4,
"instructions": "xyz789",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"deletedAt": datetime
}
}
}
linkEstimateToNote
Response
Returns a LinkEstimateToNoteResponse!
Arguments
| Name | Description |
|---|---|
input - LinkEstimateToNoteInput!
|
Example
Query
mutation LinkEstimateToNote($input: LinkEstimateToNoteInput!) {
linkEstimateToNote(input: $input) {
success
message
estimateId
}
}
Variables
{"input": LinkEstimateToNoteInput}
Response
{
"data": {
"linkEstimateToNote": {
"success": false,
"message": "xyz789",
"estimateId": 4
}
}
}
linkProvider
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - LinkProviderInput!
|
Example
Query
mutation LinkProvider($input: LinkProviderInput!) {
linkProvider(input: $input)
}
Variables
{"input": LinkProviderInput}
Response
{"data": {"linkProvider": false}}
linkTransactionToInvoices
Response
Returns [TransactionSchema!]!
Arguments
| Name | Description |
|---|---|
input - TransactionInvoiceLinkSchema!
|
Example
Query
mutation LinkTransactionToInvoices($input: TransactionInvoiceLinkSchema!) {
linkTransactionToInvoices(input: $input) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"input": TransactionInvoiceLinkSchema}
Response
{
"data": {
"linkTransactionToInvoices": [
{
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": "4",
"familyId": "4",
"clientId": "4",
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": 4,
"voidedTransactionId": 4,
"otherInvoiceIds": ["4"],
"otherTransactionIds": [4],
"partialVoid": false,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "abc123",
"createdAt": datetime,
"balanceAmount": 123,
"isManualPartialRefund": false
}
]
}
}
lockAndPayInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceLockAndPaySchema!
|
Example
Query
mutation LockAndPayInvoice($input: InvoiceLockAndPaySchema!) {
lockAndPayInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceLockAndPaySchema}
Response
{
"data": {
"lockAndPayInvoice": {
"invoiceId": "4",
"patientId": 4,
"status": "OPEN",
"clientId": "4",
"creatorUid": "4",
"voidedUid": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": true,
"tax": 123,
"taxRate": 123.45,
"pstTax": 123,
"pstTaxRate": 123.45,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"total": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "xyz789",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": true,
"isMigrated": false,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 123,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
}
}
lockInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceLockSchema!
|
Example
Query
mutation LockInvoice($input: InvoiceLockSchema!) {
lockInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceLockSchema}
Response
{
"data": {
"lockInvoice": {
"invoiceId": "4",
"patientId": 4,
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": 4,
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": true,
"tax": 123,
"taxRate": 987.65,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"total": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": true,
"storeCreditApplied": 123,
"storeCreditManuallySet": false,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 987,
"outstandingBalance": 123,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
}
}
lockInvoices
Response
Returns [InvoiceSchema!]!
Arguments
| Name | Description |
|---|---|
input - InvoicesLockSchema!
|
Example
Query
mutation LockInvoices($input: InvoicesLockSchema!) {
lockInvoices(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoicesLockSchema}
Response
{
"data": {
"lockInvoices": [
{
"invoiceId": "4",
"patientId": "4",
"status": "OPEN",
"clientId": 4,
"creatorUid": 4,
"voidedUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"estimateId": 4,
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 123,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"total": 987,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": false,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "abc123",
"isInterestCharge": false,
"isMigrated": false,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 123,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
]
}
}
lockSoap
lockSurgery
lockVisitNote
loginAs
Response
Returns a LoginAsResponseSchema!
Arguments
| Name | Description |
|---|---|
input - LoginAsSchema!
|
Example
Query
mutation LoginAs($input: LoginAsSchema!) {
loginAs(input: $input) {
message
adminId
}
}
Variables
{"input": LoginAsSchema}
Response
{
"data": {
"loginAs": {
"message": "xyz789",
"adminId": "abc123"
}
}
}
markAsReceivedSkipLinking
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - MarkAsReceivedSkipLinkingSchema!
|
Example
Query
mutation MarkAsReceivedSkipLinking($input: MarkAsReceivedSkipLinkingSchema!) {
markAsReceivedSkipLinking(input: $input)
}
Variables
{"input": MarkAsReceivedSkipLinkingSchema}
Response
{"data": {"markAsReceivedSkipLinking": true}}
markConversationReadByClinic
Response
Returns a ConversationSchema!
Arguments
| Name | Description |
|---|---|
conversationId - ID!
|
Example
Query
mutation MarkConversationReadByClinic($conversationId: ID!) {
markConversationReadByClinic(conversationId: $conversationId) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"conversationId": "4"}
Response
{
"data": {
"markConversationReadByClinic": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": "4",
"createdAt": datetime,
"updatedAt": datetime,
"clientId": 4,
"unknownPhoneNumber": "abc123",
"isArchived": false,
"readAt": datetime,
"unreadCount": 123,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
markConversationReadByEmployee
Response
Returns a ConversationSchema!
Example
Query
mutation MarkConversationReadByEmployee(
$conversationId: ID!,
$employeeId: ID!
) {
markConversationReadByEmployee(
conversationId: $conversationId,
employeeId: $employeeId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"conversationId": "4", "employeeId": 4}
Response
{
"data": {
"markConversationReadByEmployee": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": "4",
"unknownPhoneNumber": "abc123",
"isArchived": true,
"readAt": datetime,
"unreadCount": 123,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
markConversationUnreadByClinic
Response
Returns a ConversationSchema!
Example
Query
mutation MarkConversationUnreadByClinic(
$conversationId: ID!,
$messageId: ID!
) {
markConversationUnreadByClinic(
conversationId: $conversationId,
messageId: $messageId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{
"conversationId": "4",
"messageId": "4"
}
Response
{
"data": {
"markConversationUnreadByClinic": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": "4",
"unknownPhoneNumber": "xyz789",
"isArchived": true,
"readAt": datetime,
"unreadCount": 123,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
markConversationUnreadByEmployee
Response
Returns a ConversationSchema!
Example
Query
mutation MarkConversationUnreadByEmployee(
$conversationId: ID!,
$messageId: ID!,
$employeeId: ID!
) {
markConversationUnreadByEmployee(
conversationId: $conversationId,
messageId: $messageId,
employeeId: $employeeId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"conversationId": 4, "messageId": 4, "employeeId": 4}
Response
{
"data": {
"markConversationUnreadByEmployee": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": 4,
"unknownPhoneNumber": "xyz789",
"isArchived": false,
"readAt": datetime,
"unreadCount": 987,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
markInvoicesAsPaid
Response
Returns [InvoiceSchema!]!
Arguments
| Name | Description |
|---|---|
input - InvoicesMarkAsPaidSchema!
|
Example
Query
mutation MarkInvoicesAsPaid($input: InvoicesMarkAsPaidSchema!) {
markInvoicesAsPaid(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoicesMarkAsPaidSchema}
Response
{
"data": {
"markInvoicesAsPaid": [
{
"invoiceId": "4",
"patientId": 4,
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": "4",
"parentInvoiceId": "4",
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": true,
"tax": 987,
"taxRate": 123.45,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 987,
"total": 987,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 987,
"outstandingBalance": 123,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
]
}
}
mergeClients
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ClientMergeInput!
|
Example
Query
mutation MergeClients($input: ClientMergeInput!) {
mergeClients(input: $input)
}
Variables
{"input": ClientMergeInput}
Response
{"data": {"mergeClients": false}}
mergePatients
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - PatientMergeInput!
|
Example
Query
mutation MergePatients($input: PatientMergeInput!) {
mergePatients(input: $input)
}
Variables
{"input": PatientMergeInput}
Response
{"data": {"mergePatients": true}}
notifyAppUpdateChange
Response
Returns a Boolean!
Example
Query
mutation NotifyAppUpdateChange {
notifyAppUpdateChange
}
Response
{"data": {"notifyAppUpdateChange": false}}
notifyTreatmentsChange
Response
Returns a SettingsSchema!
Example
Query
mutation NotifyTreatmentsChange {
notifyTreatmentsChange {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Response
{
"data": {
"notifyTreatmentsChange": {
"practiceId": "4",
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "abc123",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "abc123",
"state": "abc123",
"country": "xyz789",
"zipCode": "xyz789",
"name": "xyz789",
"status": "OPEN",
"email": "abc123",
"phone": "abc123",
"twilioPhone": "xyz789",
"timezone": "abc123",
"clinicLogoMediaId": 4,
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 987,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "xyz789",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 987,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
}
}
patchSoapTemplate
Response
Returns a SoapTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SoapTemplateUpdateSchema!
|
Example
Query
mutation PatchSoapTemplate($input: SoapTemplateUpdateSchema!) {
patchSoapTemplate(input: $input) {
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SoapTemplateUpdateSchema}
Response
{
"data": {
"patchSoapTemplate": {
"appointmentType": AppointmentTypeResolveSchema,
"id": "4",
"creatorId": "4",
"name": "abc123",
"species": "abc123",
"appointmentTypeId": 4,
"isDeleted": false,
"favoritedBy": [4],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
pauseSubscription
Response
Returns a SubscriptionSchema!
Arguments
| Name | Description |
|---|---|
input - PauseSubscriptionInput!
|
Example
Query
mutation PauseSubscription($input: PauseSubscriptionInput!) {
pauseSubscription(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"input": PauseSubscriptionInput}
Response
{
"data": {
"pauseSubscription": {
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "abc123",
"accountId": "abc123",
"customerId": "abc123",
"status": "ACTIVE",
"price": 123,
"currency": "AUD",
"intervalUnit": "abc123",
"intervalCount": 123,
"paymentMethodId": "abc123",
"platformFeeAmount": 123,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
}
}
processAudioAndCreateVisitNote
Response
Returns a VisitNoteSchema!
Arguments
| Name | Description |
|---|---|
input - ProcessAudioAndCreateVisitNoteInput!
|
Example
Query
mutation ProcessAudioAndCreateVisitNote($input: ProcessAudioAndCreateVisitNoteInput!) {
processAudioAndCreateVisitNote(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
voiceNoteId
notes
details
recs
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
}
}
Variables
{"input": ProcessAudioAndCreateVisitNoteInput}
Response
{
"data": {
"processAudioAndCreateVisitNote": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": "4",
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"voiceNoteId": 4,
"notes": "xyz789",
"details": "xyz789",
"recs": "abc123",
"assessment": SoapAssessmentSchema
}
}
}
processUploadedAudioFile
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ProcessUploadedAudioFileRequest!
|
Example
Query
mutation ProcessUploadedAudioFile($input: ProcessUploadedAudioFileRequest!) {
processUploadedAudioFile(input: $input)
}
Variables
{"input": ProcessUploadedAudioFileRequest}
Response
{
"data": {
"processUploadedAudioFile": "xyz789"
}
}
realUpdateRxScript
Response
Returns a RxScriptSchema!
Arguments
| Name | Description |
|---|---|
input - RxScriptRealUpdateSchema!
|
Example
Query
mutation RealUpdateRxScript($input: RxScriptRealUpdateSchema!) {
realUpdateRxScript(input: $input) {
originalRxScript {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
treatmentobj {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
Variables
{"input": RxScriptRealUpdateSchema}
Response
{
"data": {
"realUpdateRxScript": {
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": "4",
"patientId": "4",
"creatorUid": "4",
"filledById": 4,
"clientId": "4",
"refId": "4",
"originalRefId": "4",
"renewedRefId": 4,
"renewedFromRefId": 4,
"treatmentId": 4,
"treatmentInstanceId": 4,
"treatment": "xyz789",
"totalDosage": Decimal,
"duration": 123,
"durationUnit": "MINUTES",
"customDoseUnit": "abc123",
"isCustomTreatment": true,
"customTreatmentIsRxScript": false,
"refills": 123,
"instructions": "xyz789",
"voided": false,
"voidReason": "xyz789",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
}
}
reconcileCash
Response
Returns a TransactionSchema!
Arguments
| Name | Description |
|---|---|
input - ReconcileCashCreateSchema!
|
Example
Query
mutation ReconcileCash($input: ReconcileCashCreateSchema!) {
reconcileCash(input: $input) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"input": ReconcileCashCreateSchema}
Response
{
"data": {
"reconcileCash": {
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": true,
"transactionId": "4",
"familyId": 4,
"clientId": 4,
"creatorUid": "4",
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 987,
"invoiceId": "4",
"voidedTransactionId": "4",
"otherInvoiceIds": ["4"],
"otherTransactionIds": [4],
"partialVoid": true,
"method": "CASH",
"network": "PRO_BONO",
"notes": "abc123",
"paymentIntentId": "xyz789",
"refundId": "abc123",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": true
}
}
}
refundInvoiceItem
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceRefundItemSchema!
|
Example
Query
mutation RefundInvoiceItem($input: InvoiceRefundItemSchema!) {
refundInvoiceItem(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceRefundItemSchema}
Response
{
"data": {
"refundInvoiceItem": {
"invoiceId": "4",
"patientId": "4",
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 987,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 987,
"discount": 987,
"total": 123,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": false,
"storeCreditApplied": 987,
"storeCreditManuallySet": false,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "abc123",
"isInterestCharge": true,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 987,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
}
}
refundTransaction
Response
Returns a TransactionSchema!
Arguments
| Name | Description |
|---|---|
input - TransactionRefundSchema!
|
Example
Query
mutation RefundTransaction($input: TransactionRefundSchema!) {
refundTransaction(input: $input) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"input": TransactionRefundSchema}
Response
{
"data": {
"refundTransaction": {
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": "4",
"familyId": "4",
"clientId": 4,
"creatorUid": "4",
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": 4,
"voidedTransactionId": "4",
"otherInvoiceIds": [4],
"otherTransactionIds": ["4"],
"partialVoid": false,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": true
}
}
}
removeConversationParticipant
Response
Returns a ConversationSchema!
Example
Query
mutation RemoveConversationParticipant(
$employeeId: ID!,
$conversationId: ID!
) {
removeConversationParticipant(
employeeId: $employeeId,
conversationId: $conversationId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"employeeId": 4, "conversationId": 4}
Response
{
"data": {
"removeConversationParticipant": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": "4",
"createdAt": datetime,
"updatedAt": datetime,
"clientId": "4",
"unknownPhoneNumber": "abc123",
"isArchived": false,
"readAt": datetime,
"unreadCount": 123,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
removeFormFromSoap
Response
Returns a SoapSchema!
Arguments
| Name | Description |
|---|---|
input - SoapAddFormSchema!
|
Example
Query
mutation RemoveFormFromSoap($input: SoapAddFormSchema!) {
removeFormFromSoap(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
vet {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
skin {
...SoapObjectiveEntrySchemaFragment
}
eyes {
...SoapObjectiveEntrySchemaFragment
}
ears {
...SoapObjectiveEntrySchemaFragment
}
nose {
...SoapObjectiveEntrySchemaFragment
}
oral {
...SoapObjectiveEntrySchemaFragment
}
heart {
...SoapObjectiveEntrySchemaFragment
}
lungs {
...SoapObjectiveEntrySchemaFragment
}
ln {
...SoapObjectiveEntrySchemaFragment
}
abd {
...SoapObjectiveEntrySchemaFragment
}
urogenital {
...SoapObjectiveEntrySchemaFragment
}
ms {
...SoapObjectiveEntrySchemaFragment
}
neuro {
...SoapObjectiveEntrySchemaFragment
}
rectal {
...SoapObjectiveEntrySchemaFragment
}
notes
createdAt
}
assessment {
problems {
...SoapDiagnosisSchemaFragment
}
diagnoses {
...SoapDiagnosisSchemaFragment
}
ruleouts {
...SoapDiagnosisSchemaFragment
}
notes
createdAt
updatedAt
}
recs
forms
voiceNoteApprovedSignature
}
}
Variables
{"input": SoapAddFormSchema}
Response
{
"data": {
"removeFormFromSoap": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": "4",
"providerId": "4",
"creatorUid": "4",
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [
SoapSurgeryPatientDiagramSchema
],
"vet": ClinicUserSchema,
"soapId": "4",
"vetUid": "4",
"voiceNoteId": "4",
"details": "abc123",
"subjective": "abc123",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "abc123",
"forms": ["4"],
"voiceNoteApprovedSignature": "abc123"
}
}
}
removeFutureScheduledEvents
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
input - RemoveFutureScheduledEventsSchema!
|
Example
Query
mutation RemoveFutureScheduledEvents($input: RemoveFutureScheduledEventsSchema!) {
removeFutureScheduledEvents(input: $input) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": RemoveFutureScheduledEventsSchema}
Response
{
"data": {
"removeFutureScheduledEvents": {
"id": "4",
"patientId": 4,
"clientId": "4",
"providerId": "4",
"techUid": 4,
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
renewRxScript
Response
Returns a RxScriptSchema!
Arguments
| Name | Description |
|---|---|
input - RxScriptRenewSchema!
|
Example
Query
mutation RenewRxScript($input: RxScriptRenewSchema!) {
renewRxScript(input: $input) {
originalRxScript {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
treatmentobj {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
Variables
{"input": RxScriptRenewSchema}
Response
{
"data": {
"renewRxScript": {
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": 4,
"patientId": 4,
"creatorUid": "4",
"filledById": "4",
"clientId": 4,
"refId": "4",
"originalRefId": 4,
"renewedRefId": "4",
"renewedFromRefId": 4,
"treatmentId": 4,
"treatmentInstanceId": 4,
"treatment": "abc123",
"totalDosage": Decimal,
"duration": 987,
"durationUnit": "MINUTES",
"customDoseUnit": "abc123",
"isCustomTreatment": false,
"customTreatmentIsRxScript": false,
"refills": 123,
"instructions": "xyz789",
"voided": true,
"voidReason": "abc123",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
}
}
reorderAppointmentTypes
Response
Returns [AppointmentTypeSchema!]!
Arguments
| Name | Description |
|---|---|
input - AppointmentTypeOrderSchema!
|
Example
Query
mutation ReorderAppointmentTypes($input: AppointmentTypeOrderSchema!) {
reorderAppointmentTypes(input: $input) {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": AppointmentTypeOrderSchema}
Response
{
"data": {
"reorderAppointmentTypes": [
{
"id": 4,
"creatorId": "4",
"legacyKey": "abc123",
"name": "abc123",
"category": "MEDICAL",
"description": "xyz789",
"color": "xyz789",
"defaultMinutes": 123,
"depositRequired": true,
"depositAmount": 987,
"order": 987,
"directOnlineEnabled": true,
"isRequired": false,
"sendReminderNotifications": true,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
reorderCalendarEmployees
Response
Returns [ClinicUserSchema!]!
Arguments
| Name | Description |
|---|---|
input - EmployeeCalendarOrderSchema!
|
Example
Query
mutation ReorderCalendarEmployees($input: EmployeeCalendarOrderSchema!) {
reorderCalendarEmployees(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": EmployeeCalendarOrderSchema}
Response
{
"data": {
"reorderCalendarEmployees": [
{
"profilePicture": MediaSchema,
"id": "4",
"firstName": "abc123",
"lastName": "abc123",
"emailH": "abc123",
"emailW": "abc123",
"phoneH": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": false,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
]
}
}
replaceSurgeryVitals
Response
Returns [SurgeryVitalSchema!]!
Arguments
| Name | Description |
|---|---|
input - SurgeryVitalsReplaceSchema!
|
Example
Query
mutation ReplaceSurgeryVitals($input: SurgeryVitalsReplaceSchema!) {
replaceSurgeryVitals(input: $input) {
id
name
order
}
}
Variables
{"input": SurgeryVitalsReplaceSchema}
Response
{
"data": {
"replaceSurgeryVitals": [
{
"id": 4,
"name": "abc123",
"order": 123
}
]
}
}
resendFormSubmission
resetPassword
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ResetPasswordSchema!
|
Example
Query
mutation ResetPassword($input: ResetPasswordSchema!) {
resetPassword(input: $input)
}
Variables
{"input": ResetPasswordSchema}
Response
{"data": {"resetPassword": true}}
resumeSubscription
Response
Returns a SubscriptionSchema!
Arguments
| Name | Description |
|---|---|
input - ResumeSubscriptionInput!
|
Example
Query
mutation ResumeSubscription($input: ResumeSubscriptionInput!) {
resumeSubscription(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"input": ResumeSubscriptionInput}
Response
{
"data": {
"resumeSubscription": {
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "abc123",
"accountId": "xyz789",
"customerId": "abc123",
"status": "ACTIVE",
"price": 987,
"currency": "AUD",
"intervalUnit": "abc123",
"intervalCount": 123,
"paymentMethodId": "abc123",
"platformFeeAmount": 987,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
}
}
reverseAcceptNonLinkedPurchaseOrderItem
Response
Returns a PurchaseOrderSchema!
Arguments
| Name | Description |
|---|---|
input - ReverseAcceptNonLinkedPurchaseOrderItemSchema!
|
Example
Query
mutation ReverseAcceptNonLinkedPurchaseOrderItem($input: ReverseAcceptNonLinkedPurchaseOrderItemSchema!) {
reverseAcceptNonLinkedPurchaseOrderItem(input: $input) {
id
vetcoveId
creatorUid
poNumber
subtotal
tax
shipping
total
vendorId
items {
id
name
sku
unitMeasurement
quantity
treatmentId
locationId
vetcoveItemId
unitPrice
listPrice
totalPrice
units
isLinked
packType
availabilityCode
availabilityText
manufacturerName
deletedAt
receivedAt
cancelled
expiredAt
inventoryItemId
lotId
serialNo
ndcNumber
}
orderPlacementTime
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": ReverseAcceptNonLinkedPurchaseOrderItemSchema}
Response
{
"data": {
"reverseAcceptNonLinkedPurchaseOrderItem": {
"id": 4,
"vetcoveId": 987,
"creatorUid": 4,
"poNumber": "xyz789",
"subtotal": 123,
"tax": 123,
"shipping": 987,
"total": 987,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
reverseAcceptPurchaseOrderItem
Response
Returns a PurchaseOrderSchema!
Arguments
| Name | Description |
|---|---|
input - ReverseInventoryItemFromPurchaseOrderCreateSchema!
|
Example
Query
mutation ReverseAcceptPurchaseOrderItem($input: ReverseInventoryItemFromPurchaseOrderCreateSchema!) {
reverseAcceptPurchaseOrderItem(input: $input) {
id
vetcoveId
creatorUid
poNumber
subtotal
tax
shipping
total
vendorId
items {
id
name
sku
unitMeasurement
quantity
treatmentId
locationId
vetcoveItemId
unitPrice
listPrice
totalPrice
units
isLinked
packType
availabilityCode
availabilityText
manufacturerName
deletedAt
receivedAt
cancelled
expiredAt
inventoryItemId
lotId
serialNo
ndcNumber
}
orderPlacementTime
status
deletedAt
createdAt
updatedAt
}
}
Variables
{
"input": ReverseInventoryItemFromPurchaseOrderCreateSchema
}
Response
{
"data": {
"reverseAcceptPurchaseOrderItem": {
"id": "4",
"vetcoveId": 987,
"creatorUid": "4",
"poNumber": "abc123",
"subtotal": 123,
"tax": 987,
"shipping": 987,
"total": 123,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
saveMessagesToPatientHistory
Response
Returns a PatientHistoryItemSchema!
Example
Query
mutation SaveMessagesToPatientHistory(
$patientId: ID!,
$messageIds: [ID!]!,
$title: String!
) {
saveMessagesToPatientHistory(
patientId: $patientId,
messageIds: $messageIds,
title: $title
) {
patientHistoryItemId
patientId
origItemId
type
status
displayString
createdAt
origItemIds
}
}
Variables
{
"patientId": 4,
"messageIds": [4],
"title": "xyz789"
}
Response
{
"data": {
"saveMessagesToPatientHistory": {
"patientHistoryItemId": 4,
"patientId": 4,
"origItemId": "4",
"type": "SOAP_NOTE",
"status": "ACTION_NEEDED",
"displayString": "abc123",
"createdAt": datetime,
"origItemIds": ["4"]
}
}
}
saveMessagesToPatientHistorySinceLastSave
Response
Returns a SaveMessagesToPatientHistorySinceLastSaveMutationResponse!
Example
Query
mutation SaveMessagesToPatientHistorySinceLastSave(
$patientId: ID!,
$conversationId: ID!,
$title: String!
) {
saveMessagesToPatientHistorySinceLastSave(
patientId: $patientId,
conversationId: $conversationId,
title: $title
) {
conversation {
assignedParticipants {
...ConversationParticipantSchemaFragment
}
updateType
participants {
...ConversationParticipantSchemaFragment
}
messages {
...ConversationMessageSchemaConnectionFragment
}
client {
...ClinicUserSchemaFragment
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
patientHistoryItem {
patientHistoryItemId
patientId
origItemId
type
status
displayString
createdAt
origItemIds
}
}
}
Variables
{
"patientId": 4,
"conversationId": "4",
"title": "xyz789"
}
Response
{
"data": {
"saveMessagesToPatientHistorySinceLastSave": {
"conversation": ConversationSchema,
"patientHistoryItem": PatientHistoryItemSchema
}
}
}
scheduleAndRequestAppointment
Response
Returns an AppointmentSchema!
Arguments
| Name | Description |
|---|---|
input - OnlineAppointmentScheduleSchema!
|
Example
Query
mutation ScheduleAndRequestAppointment($input: OnlineAppointmentScheduleSchema!) {
scheduleAndRequestAppointment(input: $input) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{"input": OnlineAppointmentScheduleSchema}
Response
{
"data": {
"scheduleAndRequestAppointment": {
"appointmentId": 4,
"assignedUid": 4,
"creatorUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": "4",
"patient": PatientSchema,
"clientId": 4,
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": "4",
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": false,
"confirmNotifSent": true,
"isRecurring": true,
"smsReminderNotifId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": true,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "xyz789",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": false,
"convertToLocal": true
}
}
}
sendAutoSoapAsEmail
Response
Returns a Boolean!
Example
Query
mutation SendAutoSoapAsEmail(
$receiverEmail: String!,
$transcribedText: String!,
$soapText: String!
) {
sendAutoSoapAsEmail(
receiverEmail: $receiverEmail,
transcribedText: $transcribedText,
soapText: $soapText
)
}
Variables
{
"receiverEmail": "abc123",
"transcribedText": "abc123",
"soapText": "xyz789"
}
Response
{"data": {"sendAutoSoapAsEmail": true}}
sendCustomWrittenEmail
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - SendCustomWrittenEmailSchema!
|
Example
Query
mutation SendCustomWrittenEmail($input: SendCustomWrittenEmailSchema!) {
sendCustomWrittenEmail(input: $input)
}
Variables
{"input": SendCustomWrittenEmailSchema}
Response
{"data": {"sendCustomWrittenEmail": false}}
sendPdfAsEmail
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - MediaSendPdfAsEmailSchema!
|
Example
Query
mutation SendPdfAsEmail($input: MediaSendPdfAsEmailSchema!) {
sendPdfAsEmail(input: $input)
}
Variables
{"input": MediaSendPdfAsEmailSchema}
Response
{"data": {"sendPdfAsEmail": false}}
sendRequestRefillAsEmail
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RequestRefillSchema!
|
Example
Query
mutation SendRequestRefillAsEmail($input: RequestRefillSchema!) {
sendRequestRefillAsEmail(input: $input)
}
Variables
{"input": RequestRefillSchema}
Response
{"data": {"sendRequestRefillAsEmail": false}}
sendSmsMessage
Response
Returns a ConversationMessageSchema!
Example
Query
mutation SendSmsMessage(
$toPhoneNumber: String!,
$body: String,
$mediaIds: [ID!]
) {
sendSmsMessage(
toPhoneNumber: $toPhoneNumber,
body: $body,
mediaIds: $mediaIds
) {
updateType
conversation {
assignedParticipants {
...ConversationParticipantSchemaFragment
}
updateType
participants {
...ConversationParticipantSchemaFragment
}
messages {
...ConversationMessageSchemaConnectionFragment
}
client {
...ClinicUserSchemaFragment
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
medias {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
messageType
createdAt
updatedAt
fromPhoneNumber
toPhoneNumber
conversationId
body
mediaIds
patientHistoryItemIds
employeeId
status
}
}
Variables
{
"toPhoneNumber": "abc123",
"body": "",
"mediaIds": [""]
}
Response
{
"data": {
"sendSmsMessage": {
"updateType": "NEW",
"conversation": ConversationSchema,
"employee": ClinicUserSchema,
"medias": [MediaSchema],
"id": 4,
"messageType": "SMS",
"createdAt": datetime,
"updatedAt": datetime,
"fromPhoneNumber": "abc123",
"toPhoneNumber": "xyz789",
"conversationId": 4,
"body": "abc123",
"mediaIds": [4],
"patientHistoryItemIds": ["4"],
"employeeId": "4",
"status": "ACCEPTED"
}
}
}
setConversationParticipants
Response
Returns a ConversationSchema!
Example
Query
mutation SetConversationParticipants(
$employeeIds: [ID!]!,
$conversationId: ID!
) {
setConversationParticipants(
employeeIds: $employeeIds,
conversationId: $conversationId
) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"employeeIds": [4], "conversationId": "4"}
Response
{
"data": {
"setConversationParticipants": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": "4",
"unknownPhoneNumber": "xyz789",
"isArchived": true,
"readAt": datetime,
"unreadCount": 987,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
submitFormData
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - FormSubmissionDataSchema!
|
Example
Query
mutation SubmitFormData($input: FormSubmissionDataSchema!) {
submitFormData(input: $input)
}
Variables
{"input": FormSubmissionDataSchema}
Response
{"data": {"submitFormData": true}}
testEmailTemplate
Example
Query
mutation TestEmailTemplate(
$id: ID!,
$receiver: String!
) {
testEmailTemplate(
id: $id,
receiver: $receiver
)
}
Variables
{
"id": "4",
"receiver": "abc123"
}
Response
{"data": {"testEmailTemplate": true}}
testSmsTemplate
toggleFavoriteSoapTemplate
Response
Returns a SoapTemplateSchema
Arguments
| Name | Description |
|---|---|
input - SoapTemplateToggleFavoriteSchema!
|
Example
Query
mutation ToggleFavoriteSoapTemplate($input: SoapTemplateToggleFavoriteSchema!) {
toggleFavoriteSoapTemplate(input: $input) {
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SoapTemplateToggleFavoriteSchema}
Response
{
"data": {
"toggleFavoriteSoapTemplate": {
"appointmentType": AppointmentTypeResolveSchema,
"id": 4,
"creatorId": 4,
"name": "abc123",
"species": "abc123",
"appointmentTypeId": "4",
"isDeleted": false,
"favoritedBy": [4],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
toggleFavoriteSurgeryTemplate
Response
Returns a SurgeryTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SurgeryTemplateToggleFavoriteSchema!
|
Example
Query
mutation ToggleFavoriteSurgeryTemplate($input: SurgeryTemplateToggleFavoriteSchema!) {
toggleFavoriteSurgeryTemplate(input: $input) {
id
name
creatorId
species
isDeleted
favoritedBy
surgeryTemplateData {
treatments {
...TreatmentSchemaFragment
}
procedure
preopNotes
intraopMedicationNotes
intraopProcedureNotes
postopNotes
treatmentIds
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SurgeryTemplateToggleFavoriteSchema}
Response
{
"data": {
"toggleFavoriteSurgeryTemplate": {
"id": 4,
"name": "xyz789",
"creatorId": 4,
"species": "abc123",
"isDeleted": true,
"favoritedBy": ["4"],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
toggleFavoriteVisitNoteTemplate
Response
Returns a VisitNoteTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - VisitNoteTemplateToggleFavoriteSchema!
|
Example
Query
mutation ToggleFavoriteVisitNoteTemplate($input: VisitNoteTemplateToggleFavoriteSchema!) {
toggleFavoriteVisitNoteTemplate(input: $input) {
id
name
creatorId
species
isDeleted
favoritedBy
appointmentTypeId
visitNoteTemplateData {
treatments {
...TreatmentSchemaFragment
}
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
}
createdAt
updatedAt
}
}
Variables
{"input": VisitNoteTemplateToggleFavoriteSchema}
Response
{
"data": {
"toggleFavoriteVisitNoteTemplate": {
"id": "4",
"name": "abc123",
"creatorId": 4,
"species": "xyz789",
"isDeleted": false,
"favoritedBy": ["4"],
"appointmentTypeId": 4,
"visitNoteTemplateData": VisitNoteTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
toggleTodo
Response
Returns a TodoSchema!
Arguments
| Name | Description |
|---|---|
input - ToggleTodoSchema!
|
Example
Query
mutation ToggleTodo($input: ToggleTodoSchema!) {
toggleTodo(input: $input) {
id
completed
todoType
}
}
Variables
{"input": ToggleTodoSchema}
Response
{
"data": {
"toggleTodo": {
"id": "4",
"completed": true,
"todoType": "VACCINE_CERTIFICATE"
}
}
}
transferAndDeleteSpecies
Example
Query
mutation TransferAndDeleteSpecies(
$speciesId: ID!,
$transferToSpeciesId: ID!
) {
transferAndDeleteSpecies(
speciesId: $speciesId,
transferToSpeciesId: $transferToSpeciesId
)
}
Variables
{"speciesId": 4, "transferToSpeciesId": "4"}
Response
{"data": {"transferAndDeleteSpecies": true}}
transferPatientToFamily
Response
Returns a PatientSchema!
Example
Query
mutation TransferPatientToFamily(
$patientId: ID!,
$familyId: ID!
) {
transferPatientToFamily(
patientId: $patientId,
familyId: $familyId
) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{
"patientId": "4",
"familyId": "4"
}
Response
{
"data": {
"transferPatientToFamily": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "abc123",
"familyId": 4,
"contactUid": "4",
"firstName": "abc123",
"status": "ACTIVE",
"species": "abc123",
"lastName": "abc123",
"breed": "xyz789",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 123.45,
"weightKg": 987.65,
"gender": "MALE",
"spayNeuter": true,
"photoUrl": "xyz789",
"warnings": "abc123",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
unlinkEstimateFromNote
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
input - EstimateUnlinkFromNoteSchema!
|
Example
Query
mutation UnlinkEstimateFromNote($input: EstimateUnlinkFromNoteSchema!) {
unlinkEstimateFromNote(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimateUnlinkFromNoteSchema}
Response
{
"data": {
"unlinkEstimateFromNote": {
"soap": SoapSchema,
"estimateId": "4",
"status": "OPEN",
"patientId": "4",
"creatorUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": "4",
"items": [EstimateItemSchema],
"isRange": true,
"minSubtotal": 123,
"maxSubtotal": 987,
"isTaxExempt": false,
"minTax": 123,
"maxTax": 123,
"minPstTax": 987,
"maxPstTax": 123,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 123,
"minTotal": 987,
"maxTotal": 123,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": 4,
"otherApproverName": "xyz789",
"media": [MediaSchema],
"title": "xyz789",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
unlinkProvider
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UnlinkProviderInput!
|
Example
Query
mutation UnlinkProvider($input: UnlinkProviderInput!) {
unlinkProvider(input: $input)
}
Variables
{"input": UnlinkProviderInput}
Response
{"data": {"unlinkProvider": false}}
unlockInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceUnlockSchema!
|
Example
Query
mutation UnlockInvoice($input: InvoiceUnlockSchema!) {
unlockInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceUnlockSchema}
Response
{
"data": {
"unlockInvoice": {
"invoiceId": "4",
"patientId": 4,
"status": "OPEN",
"clientId": "4",
"creatorUid": "4",
"voidedUid": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": 4,
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 123,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 123,
"total": 987,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": false,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "xyz789",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 123,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 123,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
}
}
unlockSoap
unlockSurgery
unlockVisitNote
updateAccountsReceivable
Response
Returns a Void
Example
Query
mutation UpdateAccountsReceivable {
updateAccountsReceivable
}
Response
{"data": {"updateAccountsReceivable": null}}
updateAddendum
Response
Returns an AddendumSchema!
Arguments
| Name | Description |
|---|---|
input - AddendumUpdateSchema!
|
Example
Query
mutation UpdateAddendum($input: AddendumUpdateSchema!) {
updateAddendum(input: $input) {
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": AddendumUpdateSchema}
Response
{
"data": {
"updateAddendum": {
"creator": ClinicUserSchema,
"id": 4,
"refId": 4,
"refType": "SOAP",
"creatorId": "4",
"description": "abc123",
"timestamp": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateAppointment
Response
Returns an AppointmentSchema!
Arguments
| Name | Description |
|---|---|
input - AppointmentUpdateSchema!
|
Example
Query
mutation UpdateAppointment($input: AppointmentUpdateSchema!) {
updateAppointment(input: $input) {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patientId
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
clientId
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
lastAppointment {
appointmentId
assignedUid
creatorUid
soapId
surgeryId
visitNoteId
assignedEmployee {
...ClinicUserSchemaFragment
}
patientId
patient {
...PatientSchemaFragment
}
clientId
client {
...ClinicUserSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
appointmentTypeId
status
startDatetime
endDatetime
checkinTime
staffNotes
reminderNotifSent
confirmNotifSent
isRecurring
smsReminderNotifId
createdAt
updatedAt
isOnlineRequest
followUpNotes
alternativeTimes
onlineRequestExpireAt
cancellationReason
}
isEmailable
isSmsable
convertToLocal
}
}
Variables
{"input": AppointmentUpdateSchema}
Response
{
"data": {
"updateAppointment": {
"appointmentId": 4,
"assignedUid": 4,
"creatorUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"assignedEmployee": ClinicUserSchema,
"patientId": "4",
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "xyz789",
"reminderNotifSent": true,
"confirmNotifSent": true,
"isRecurring": false,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": true,
"followUpNotes": "xyz789",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "xyz789",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": true,
"convertToLocal": false
}
}
}
updateAppointmentCheckout
Response
Returns an AppointmentCheckoutSchema!
Arguments
| Name | Description |
|---|---|
input - AppointmentCheckoutUpdateSchema!
|
Example
Query
mutation UpdateAppointmentCheckout($input: AppointmentCheckoutUpdateSchema!) {
updateAppointmentCheckout(input: $input) {
id
appointmentId
soapId
surgeryId
deletedAt
todos {
... on EmailOrPrintTodoSchema {
...EmailOrPrintTodoSchemaFragment
}
... on RxScriptTodoSchema {
...RxScriptTodoSchemaFragment
}
... on VaccineCertificateTodoSchema {
...VaccineCertificateTodoSchemaFragment
}
... on LabTodoSchema {
...LabTodoSchemaFragment
}
... on ScheduleFollowUpTodoSchema {
...ScheduleFollowUpTodoSchemaFragment
}
... on PaymentTodoSchema {
...PaymentTodoSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": AppointmentCheckoutUpdateSchema}
Response
{
"data": {
"updateAppointmentCheckout": {
"id": "4",
"appointmentId": "4",
"soapId": 4,
"surgeryId": 4,
"deletedAt": datetime,
"todos": [EmailOrPrintTodoSchema],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateAppointmentType
Response
Returns an AppointmentTypeSchema!
Arguments
| Name | Description |
|---|---|
input - AppointmentTypeUpdateSchema!
|
Example
Query
mutation UpdateAppointmentType($input: AppointmentTypeUpdateSchema!) {
updateAppointmentType(input: $input) {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": AppointmentTypeUpdateSchema}
Response
{
"data": {
"updateAppointmentType": {
"id": 4,
"creatorId": 4,
"legacyKey": "xyz789",
"name": "xyz789",
"category": "MEDICAL",
"description": "abc123",
"color": "xyz789",
"defaultMinutes": 123,
"depositRequired": true,
"depositAmount": 987,
"order": 987,
"directOnlineEnabled": false,
"isRequired": false,
"sendReminderNotifications": true,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateBoardingReservation
Response
Returns a BoardingReservationSchema!
Arguments
| Name | Description |
|---|---|
input - BoardingReservationUpdateSchema!
|
Example
Query
mutation UpdateBoardingReservation($input: BoardingReservationUpdateSchema!) {
updateBoardingReservation(input: $input) {
id
creatorId
patientId
kennelId
startDatetime
endDatetime
notes
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": BoardingReservationUpdateSchema}
Response
{
"data": {
"updateBoardingReservation": {
"id": 4,
"creatorId": 4,
"patientId": 4,
"kennelId": 4,
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateBreed
Response
Returns a BreedSchema!
Arguments
| Name | Description |
|---|---|
input - BreedInputSchema!
|
Example
Query
mutation UpdateBreed($input: BreedInputSchema!) {
updateBreed(input: $input) {
breedId
name
species
imageData
}
}
Variables
{"input": BreedInputSchema}
Response
{
"data": {
"updateBreed": {
"breedId": 4,
"name": "abc123",
"species": "xyz789",
"imageData": "abc123"
}
}
}
updateBundle
Response
Returns a BundleSchema!
Arguments
| Name | Description |
|---|---|
input - BundleUpdateSchema!
|
Example
Query
mutation UpdateBundle($input: BundleUpdateSchema!) {
updateBundle(input: $input) {
bundleId
name
treatments {
name
treatmentId
pricePerUnit
minimumQty
maximumQty
order
hideItem
}
createdAt
updatedAt
useQtyRange
hideAllItemsPrices
}
}
Variables
{"input": BundleUpdateSchema}
Response
{
"data": {
"updateBundle": {
"bundleId": "4",
"name": "xyz789",
"treatments": [BundleTreatmentSchema],
"createdAt": datetime,
"updatedAt": datetime,
"useQtyRange": true,
"hideAllItemsPrices": true
}
}
}
updateClient
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
input - ClientUpdateSchema!
|
Example
Query
mutation UpdateClient($input: ClientUpdateSchema!) {
updateClient(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": ClientUpdateSchema}
Response
{
"data": {
"updateClient": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "abc123",
"lastName": "xyz789",
"emailH": "abc123",
"emailW": "abc123",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
updateClinicEmployeeSchedule
Response
Returns a ScheduleSchema!
Arguments
| Name | Description |
|---|---|
scheduleId - ID!
|
|
creatorUid - ID!
|
|
type - ScheduleType
|
Default = null |
startDatetime - datetime
|
Default = null |
endDatetime - datetime
|
Default = null |
fullDay - Boolean
|
Default = null |
rrule - String
|
Default = null |
onlineBookingConfig - OnlineBookingConfigUpdateSchema
|
Default = null |
Example
Query
mutation UpdateClinicEmployeeSchedule(
$scheduleId: ID!,
$creatorUid: ID!,
$type: ScheduleType,
$startDatetime: datetime,
$endDatetime: datetime,
$fullDay: Boolean,
$rrule: String,
$onlineBookingConfig: OnlineBookingConfigUpdateSchema
) {
updateClinicEmployeeSchedule(
scheduleId: $scheduleId,
creatorUid: $creatorUid,
type: $type,
startDatetime: $startDatetime,
endDatetime: $endDatetime,
fullDay: $fullDay,
rrule: $rrule,
onlineBookingConfig: $onlineBookingConfig
) {
scheduleId
type
creatorUid
employeeUid
startDatetime
endDatetime
fullDay
rrule
onlineBookingConfig {
enabled
appointmentTypesAllowed
}
createdAt
updatedAt
}
}
Variables
{
"scheduleId": "4",
"creatorUid": "4",
"type": "null",
"startDatetime": null,
"endDatetime": null,
"fullDay": null,
"rrule": null,
"onlineBookingConfig": null
}
Response
{
"data": {
"updateClinicEmployeeSchedule": {
"scheduleId": "4",
"type": "WORK_HOURS",
"creatorUid": "4",
"employeeUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"rrule": "abc123",
"onlineBookingConfig": OnlineBookingConfigSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateColor
Response
Returns a ColorSchema!
Arguments
| Name | Description |
|---|---|
input - ColorInputSchema!
|
Example
Query
mutation UpdateColor($input: ColorInputSchema!) {
updateColor(input: $input) {
colorId
name
species
}
}
Variables
{"input": ColorInputSchema}
Response
{
"data": {
"updateColor": {
"colorId": "4",
"name": "xyz789",
"species": "abc123"
}
}
}
updateCommissionSettings
Response
Returns a CommissionSettingSchema!
Arguments
| Name | Description |
|---|---|
input - CommissionSettingUpdateSchema!
|
Example
Query
mutation UpdateCommissionSettings($input: CommissionSettingUpdateSchema!) {
updateCommissionSettings(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
originalCommissionSettingId
typeName
typeCode
categoryName
categoryCode
treatmentId
commissionRate
userId
type
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": CommissionSettingUpdateSchema}
Response
{
"data": {
"updateCommissionSettings": {
"treatment": TreatmentSchema,
"id": "4",
"originalCommissionSettingId": "4",
"typeName": "abc123",
"typeCode": "xyz789",
"categoryName": "abc123",
"categoryCode": "xyz789",
"treatmentId": 4,
"commissionRate": 987.65,
"userId": "4",
"type": "TREATMENT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateCommunication
Response
Returns a CommunicationSchema!
Arguments
| Name | Description |
|---|---|
input - CommunicationUpdateSchema!
|
Example
Query
mutation UpdateCommunication($input: CommunicationUpdateSchema!) {
updateCommunication(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
callAnalytics {
summary
sentiment
transcript
}
communicationId
clientId
patientId
employeeId
communicationType
communication
contactDatetime
status
mediaId
mangoWebhookRequestId
voidReason
createdAt
updatedAt
}
}
Variables
{"input": CommunicationUpdateSchema}
Response
{
"data": {
"updateCommunication": {
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"patient": PatientSchema,
"media": MediaSchema,
"callAnalytics": CallSummaryAnalyticsSchema,
"communicationId": "4",
"clientId": "4",
"patientId": 4,
"employeeId": 4,
"communicationType": "PHONE",
"communication": "abc123",
"contactDatetime": datetime,
"status": "OPEN",
"mediaId": 4,
"mangoWebhookRequestId": "abc123",
"voidReason": "abc123",
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateDiagnosis
Response
Returns a DiagnosisSchema!
Arguments
| Name | Description |
|---|---|
input - DiagnosisUpdateSchema!
|
Example
Query
mutation UpdateDiagnosis($input: DiagnosisUpdateSchema!) {
updateDiagnosis(input: $input) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
name
source
dischargeDocumentIds
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": DiagnosisUpdateSchema}
Response
{
"data": {
"updateDiagnosis": {
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"name": "xyz789",
"source": "AAHA",
"dischargeDocumentIds": ["4"],
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateDischargeDocument
Response
Returns a DischargeDocumentSchema!
Arguments
| Name | Description |
|---|---|
input - DischargeDocumentUpdateSchema!
|
Example
Query
mutation UpdateDischargeDocument($input: DischargeDocumentUpdateSchema!) {
updateDischargeDocument(input: $input) {
linkedDiagnoses {
id
name
}
linkedTreatments {
treatmentId
name
species
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": DischargeDocumentUpdateSchema}
Response
{
"data": {
"updateDischargeDocument": {
"linkedDiagnoses": [DiagnosisBasicSchema],
"linkedTreatments": [TreatmentBasicSchema],
"id": "4",
"fileName": "xyz789",
"documentName": "xyz789",
"mediaId": 4,
"species": "abc123",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateEmailTemplate
Response
Returns an EmailTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - EmailTemplateUpdateSchema!
|
Example
Query
mutation UpdateEmailTemplate($input: EmailTemplateUpdateSchema!) {
updateEmailTemplate(input: $input) {
postFooter
availableVariables
id
name
description
key
templateKey
enabled
type
replyTo
subject
body
bodyJson
footer
footerJson
linkedFormIds
createdAt
updatedAt
}
}
Variables
{"input": EmailTemplateUpdateSchema}
Response
{
"data": {
"updateEmailTemplate": {
"postFooter": "abc123",
"availableVariables": {},
"id": "4",
"name": "abc123",
"description": "xyz789",
"key": "xyz789",
"templateKey": "xyz789",
"enabled": false,
"type": "SYSTEM",
"replyTo": "xyz789",
"subject": "abc123",
"body": "xyz789",
"bodyJson": "abc123",
"footer": "abc123",
"footerJson": "abc123",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateEmployee
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
input - EmployeeUpdateSchema!
|
Example
Query
mutation UpdateEmployee($input: EmployeeUpdateSchema!) {
updateEmployee(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": EmployeeUpdateSchema}
Response
{
"data": {
"updateEmployee": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"emailH": "abc123",
"emailW": "abc123",
"phoneH": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "abc123",
"state": "xyz789",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": false,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
updateEmployeeRole
Response
Returns a ClinicUserSchema!
Example
Query
mutation UpdateEmployeeRole(
$id: ID!,
$role: String!
) {
updateEmployeeRole(
id: $id,
role: $role
) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"id": 4, "role": "xyz789"}
Response
{
"data": {
"updateEmployeeRole": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"zipCode": "abc123",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": true,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
updateEstimate
Response
Returns an EstimateSchema!
Arguments
| Name | Description |
|---|---|
input - EstimateUpdateSchema!
|
Example
Query
mutation UpdateEstimate($input: EstimateUpdateSchema!) {
updateEstimate(input: $input) {
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
xrayId
isDiscountable
declined
minQty
maxQty
minPricePerUnit
maxPricePerUnit
minPrice
maxPrice
minSubtotal
maxSubtotal
minTax
maxTax
minPstTax
maxPstTax
minHasDiscount
maxHasDiscount
customPriceMax
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
title
expirationDate
createdAt
updatedAt
}
}
Variables
{"input": EstimateUpdateSchema}
Response
{
"data": {
"updateEstimate": {
"soap": SoapSchema,
"estimateId": 4,
"status": "OPEN",
"patientId": 4,
"creatorUid": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": "4",
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 123,
"maxSubtotal": 123,
"isTaxExempt": false,
"minTax": 987,
"maxTax": 987,
"minPstTax": 123,
"maxPstTax": 987,
"taxRate": 123.45,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 123,
"minTotal": 987,
"maxTotal": 123,
"approved": true,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "abc123",
"clientId": "4",
"otherApproverName": "abc123",
"media": [MediaSchema],
"title": "xyz789",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateFamily
Response
Returns a FamilyViewSchema!
Arguments
| Name | Description |
|---|---|
familyId - ID!
|
|
familyName - String
|
Default = null |
primaryContactUid - ID
|
Default = null |
secondaryContactUid - ID
|
Default = null |
status - FamilyStatus
|
Default = null |
Example
Query
mutation UpdateFamily(
$familyId: ID!,
$familyName: String,
$primaryContactUid: ID,
$secondaryContactUid: ID,
$status: FamilyStatus
) {
updateFamily(
familyId: $familyId,
familyName: $familyName,
primaryContactUid: $primaryContactUid,
secondaryContactUid: $secondaryContactUid,
status: $status
) {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
secondaryContact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
clients {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
lastReminderSentAt
}
}
Variables
{
"familyId": 4,
"familyName": null,
"primaryContactUid": null,
"secondaryContactUid": null,
"status": "null"
}
Response
{
"data": {
"updateFamily": {
"id": "4",
"familyId": "4",
"familyName": "xyz789",
"familyNameLowercase": "xyz789",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 123,
"status": "ACTIVE",
"primaryContactUid": "4",
"secondaryContactUid": 4,
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
}
}
updateForm
Response
Returns a FormSchema!
Arguments
| Name | Description |
|---|---|
input - FormUpdateSchema!
|
Example
Query
mutation UpdateForm($input: FormUpdateSchema!) {
updateForm(input: $input) {
id
title
description
uiSchema
baseSchema
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": FormUpdateSchema}
Response
{
"data": {
"updateForm": {
"id": 4,
"title": "abc123",
"description": "xyz789",
"uiSchema": {},
"baseSchema": {},
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateFormSubmission
Response
Returns a FormSubmissionSchema!
Arguments
| Name | Description |
|---|---|
input - FormSubmissionUpdateSchema!
|
Example
Query
mutation UpdateFormSubmission($input: FormSubmissionUpdateSchema!) {
updateFormSubmission(input: $input) {
url
id
formId
formData
clientId
patientId
status
publicId
message
appointmentId
sentVia
sentBy
submittedAt
deletedAt
dueDate
createdAt
updatedAt
}
}
Variables
{"input": FormSubmissionUpdateSchema}
Response
{
"data": {
"updateFormSubmission": {
"url": "abc123",
"id": "4",
"formId": "4",
"formData": {},
"clientId": 4,
"patientId": "4",
"status": "SENT",
"publicId": "xyz789",
"message": "xyz789",
"appointmentId": 4,
"sentVia": ["EMAIL"],
"sentBy": 4,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateFreemium
Response
Returns a FreemiumSchema!
Arguments
| Name | Description |
|---|---|
input - FreemiumUpdateSchema!
|
Example
Query
mutation UpdateFreemium($input: FreemiumUpdateSchema!) {
updateFreemium(input: $input) {
id
name
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": FreemiumUpdateSchema}
Response
{
"data": {
"updateFreemium": {
"id": "4",
"name": "xyz789",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateGroupDiscount
Response
Returns a GroupDiscountSchema!
Arguments
| Name | Description |
|---|---|
input - GroupDiscountUpdateSchema!
|
Example
Query
mutation UpdateGroupDiscount($input: GroupDiscountUpdateSchema!) {
updateGroupDiscount(input: $input) {
id
name
percentage
creatorId
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": GroupDiscountUpdateSchema}
Response
{
"data": {
"updateGroupDiscount": {
"id": 4,
"name": "xyz789",
"percentage": Decimal,
"creatorId": 4,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateInventoryItem
Response
Returns an InventoryItemSchema!
Arguments
| Name | Description |
|---|---|
input - InventoryItemUpdateSchema!
|
Example
Query
mutation UpdateInventoryItem($input: InventoryItemUpdateSchema!) {
updateInventoryItem(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
unitCost
totalCost
sku
uom
inventoryQuantities {
vendorId
locationId
quantityOnHand
sellRatio
createdAt
updatedAt
}
inventoryLot {
lotId
manufacturer
serialNo
ndcNumber
quantityReceived
quantityRemaining
expiredAt
receivedAt
manufacturedAt
deletedAt
createdAt
updatedAt
}
treatmentId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": InventoryItemUpdateSchema}
Response
{
"data": {
"updateInventoryItem": {
"treatment": TreatmentSchema,
"id": "4",
"unitCost": 123,
"totalCost": 123,
"sku": "xyz789",
"uom": "abc123",
"inventoryQuantities": [InventoryQuantitySchema],
"inventoryLot": InventoryLotSchema,
"treatmentId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateInventoryTransaction
Response
Returns an InventoryTransactionSchema!
Arguments
| Name | Description |
|---|---|
input - InventoryTransactionUpdateSchema!
|
Example
Query
mutation UpdateInventoryTransaction($input: InventoryTransactionUpdateSchema!) {
updateInventoryTransaction(input: $input) {
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
id
creatorId
reason
treatmentId
inventoryItemId
invoiceId
patientId
clientId
quantity
unitCost
cost
description
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": InventoryTransactionUpdateSchema}
Response
{
"data": {
"updateInventoryTransaction": {
"treatment": TreatmentSchema,
"id": 4,
"creatorId": 4,
"reason": "WASTAGE",
"treatmentId": "4",
"inventoryItemId": 4,
"invoiceId": 4,
"patientId": "4",
"clientId": "4",
"quantity": Decimal,
"unitCost": 987,
"cost": 987,
"description": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceUpdateSchema!
|
Example
Query
mutation UpdateInvoice($input: InvoiceUpdateSchema!) {
updateInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceUpdateSchema}
Response
{
"data": {
"updateInvoice": {
"invoiceId": "4",
"patientId": "4",
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": "4",
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"estimateId": "4",
"parentInvoiceId": "4",
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": true,
"tax": 987,
"taxRate": 123.45,
"pstTax": 123,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 987,
"discount": 987,
"total": 987,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "xyz789",
"invoicedAt": datetime,
"title": "abc123",
"isInterestCharge": true,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 123,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
}
}
updateInvoiceItemProvider
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceUpdateTreatmentProviderSchema!
|
Example
Query
mutation UpdateInvoiceItemProvider($input: InvoiceUpdateTreatmentProviderSchema!) {
updateInvoiceItemProvider(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceUpdateTreatmentProviderSchema}
Response
{
"data": {
"updateInvoiceItemProvider": {
"invoiceId": 4,
"patientId": 4,
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": false,
"tax": 987,
"taxRate": 123.45,
"pstTax": 123,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 987,
"total": 123,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": false,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
}
}
updateKennel
Response
Returns a KennelSchema!
Arguments
| Name | Description |
|---|---|
input - KennelUpdateSchema!
|
Example
Query
mutation UpdateKennel($input: KennelUpdateSchema!) {
updateKennel(input: $input) {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": KennelUpdateSchema}
Response
{
"data": {
"updateKennel": {
"id": "4",
"order": 123,
"kennelType": "abc123",
"description": "xyz789",
"species": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateKennelsOrder
Response
Returns [KennelSchema!]!
Arguments
| Name | Description |
|---|---|
input - KennelUpdateOrderSchema!
|
Example
Query
mutation UpdateKennelsOrder($input: KennelUpdateOrderSchema!) {
updateKennelsOrder(input: $input) {
id
order
kennelType
description
species
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": KennelUpdateOrderSchema}
Response
{
"data": {
"updateKennelsOrder": [
{
"id": "4",
"order": 987,
"kennelType": "abc123",
"description": "abc123",
"species": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
]
}
}
updateLab
Response
Returns a LabSchema!
Arguments
| Name | Description |
|---|---|
input - LabUpdateSchema!
|
Example
Query
mutation UpdateLab($input: LabUpdateSchema!) {
updateLab(input: $input) {
idexxUiUrl
orderPdfUrl
resultPdfUrl
antechV6OrderUiUrl
antechV6ResultUiUrl
notes
labResults {
id
labId
labName
referenceLow
referenceCriticalLow
referenceHigh
referenceCriticalHigh
createdAt
updatedAt
categoryName
categoryCode
name
code
result
resultText
indicator
units
referenceRange
comments
order
status
deletedAt
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
uiStatus
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
antechV6Token
idexxResultUrl
id
treatmentId
createdAt
updatedAt
labResultIds
soapId
surgeryId
visitNoteId
orderNoteId
patientId
instructions
isStaff
providerId
status
deletedAt
}
}
Variables
{"input": LabUpdateSchema}
Response
{
"data": {
"updateLab": {
"idexxUiUrl": "abc123",
"orderPdfUrl": "abc123",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "abc123",
"antechV6ResultUiUrl": "abc123",
"notes": "abc123",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "xyz789",
"idexxResultUrl": "abc123",
"id": 4,
"treatmentId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"patientId": 4,
"instructions": "xyz789",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"deletedAt": datetime
}
}
}
updateLink
Response
Returns a LinkSchema!
Arguments
| Name | Description |
|---|---|
input - LinkUpdateSchema!
|
Example
Query
mutation UpdateLink($input: LinkUpdateSchema!) {
updateLink(input: $input) {
id
url
description
linkType
creatorId
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": LinkUpdateSchema}
Response
{
"data": {
"updateLink": {
"id": "4",
"url": "abc123",
"description": "xyz789",
"linkType": "IDEXX_XRAY",
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateLocation
Response
Returns a LocationSchema!
Arguments
| Name | Description |
|---|---|
input - LocationUpdateSchema!
|
Example
Query
mutation UpdateLocation($input: LocationUpdateSchema!) {
updateLocation(input: $input) {
id
name
description
deletedAt
}
}
Variables
{"input": LocationUpdateSchema}
Response
{
"data": {
"updateLocation": {
"id": 4,
"name": "abc123",
"description": "xyz789",
"deletedAt": datetime
}
}
}
updateMedia
Response
Returns a MediaSchema!
Arguments
| Name | Description |
|---|---|
input - MediaUpdateSchema!
|
Example
Query
mutation UpdateMedia($input: MediaUpdateSchema!) {
updateMedia(input: $input) {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Variables
{"input": MediaUpdateSchema}
Response
{
"data": {
"updateMedia": {
"url": "abc123",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": 4,
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "abc123",
"deletedAt": "abc123",
"title": "abc123",
"description": "xyz789",
"summaryGeneratedByAi": false,
"transcript": "abc123",
"key": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
updateMedicalHistory
Response
Returns a MedicalHistorySchema!
Arguments
| Name | Description |
|---|---|
input - MedicalHistoryUpdateSchema!
|
Example
Query
mutation UpdateMedicalHistory($input: MedicalHistoryUpdateSchema!) {
updateMedicalHistory(input: $input) {
id
patientId
type
origItemIds
deletedAt
createdAt
updatedAt
displayDate
displayString
}
}
Variables
{"input": MedicalHistoryUpdateSchema}
Response
{
"data": {
"updateMedicalHistory": {
"id": 4,
"patientId": 4,
"type": "SOAP_NOTE",
"origItemIds": [4],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"displayDate": datetime,
"displayString": "xyz789"
}
}
}
updateMiscNote
Response
Returns a MiscNoteSchema!
Arguments
| Name | Description |
|---|---|
input - MiscNoteUpdateSchema!
|
Example
Query
mutation UpdateMiscNote($input: MiscNoteUpdateSchema!) {
updateMiscNote(input: $input) {
id
description
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": MiscNoteUpdateSchema}
Response
{
"data": {
"updateMiscNote": {
"id": "4",
"description": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateOngoingDiagnosis
Response
Returns an OngoingDiagnosisSchema!
Arguments
| Name | Description |
|---|---|
input - OngoingDiagnosisUpdateSchema!
|
Example
Query
mutation UpdateOngoingDiagnosis($input: OngoingDiagnosisUpdateSchema!) {
updateOngoingDiagnosis(input: $input) {
id
creatorId
patientId
diagnosis {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
name
source
dischargeDocumentIds
}
diagnosisDate
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": OngoingDiagnosisUpdateSchema}
Response
{
"data": {
"updateOngoingDiagnosis": {
"id": 4,
"creatorId": 4,
"patientId": "4",
"diagnosis": DiagnosisEntrySchema,
"diagnosisDate": datetime,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateOrderNote
Response
Returns an UpdatedOrderNoteResponse!
Arguments
| Name | Description |
|---|---|
input - OrderNoteUpdateSchema!
|
|
meta - CommonNoteUpdateMetaSchema
|
Default = null |
Example
Query
mutation UpdateOrderNote(
$input: OrderNoteUpdateSchema!,
$meta: CommonNoteUpdateMetaSchema
) {
updateOrderNote(
input: $input,
meta: $meta
) {
updatedOrderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
syncedInvoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
}
Variables
{"input": OrderNoteUpdateSchema, "meta": null}
Response
{
"data": {
"updateOrderNote": {
"updatedOrderNote": OrderNoteSchema,
"syncedInvoice": InvoiceSchema
}
}
}
updatePassword
Response
Returns a ClinicUserSchema!
Example
Query
mutation UpdatePassword(
$userId: ID!,
$password: String!
) {
updatePassword(
userId: $userId,
password: $password
) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{
"userId": "4",
"password": "xyz789"
}
Response
{
"data": {
"updatePassword": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "xyz789",
"lastName": "xyz789",
"emailH": "xyz789",
"emailW": "abc123",
"phoneH": "abc123",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
updatePatient
Response
Returns a PatientSchema!
Arguments
| Name | Description |
|---|---|
input - PatientUpdateSchema!
|
Example
Query
mutation UpdatePatient($input: PatientUpdateSchema!) {
updatePatient(input: $input) {
otherPatients {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
hasActiveCheckout
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
chatSessionId
question
messages {
...ChatSessionMessageSchemaFragment
}
createdAt
}
meta {
labs {
...LabsSchemaFragment
}
}
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
patientBreed {
breedId
name
species
imageData
}
speciesInfo {
id
species
imageData
createdAt
updatedAt
custom
}
contact {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
createdVia
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
}
Variables
{"input": PatientUpdateSchema}
Response
{
"data": {
"updatePatient": {
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": true,
"family": FamilyViewSchema,
"patientId": "4",
"extId": "abc123",
"familyId": "4",
"contactUid": "4",
"firstName": "abc123",
"status": "ACTIVE",
"species": "abc123",
"lastName": "abc123",
"breed": "abc123",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": true,
"photoUrl": "abc123",
"warnings": "abc123",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updatePatientDiagram
Response
Returns a PatientDiagramSchema!
Arguments
| Name | Description |
|---|---|
input - PatientDiagramUpdateSchema!
|
Example
Query
mutation UpdatePatientDiagram($input: PatientDiagramUpdateSchema!) {
updatePatientDiagram(input: $input) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
title
species
type
mediaId
nectarDefault
creatorId
createdAt
updatedAt
deletedAt
}
}
Variables
{"input": PatientDiagramUpdateSchema}
Response
{
"data": {
"updatePatientDiagram": {
"media": MediaSchema,
"id": "4",
"title": "abc123",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": "4",
"nectarDefault": false,
"creatorId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
}
}
updatePatientVitals
Response
Returns a PatientVitalSchema!
Arguments
| Name | Description |
|---|---|
input - PatientVitalUpdateSchema!
|
Example
Query
mutation UpdatePatientVitals($input: PatientVitalUpdateSchema!) {
updatePatientVitals(input: $input) {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
}
Variables
{"input": PatientVitalUpdateSchema}
Response
{
"data": {
"updatePatientVitals": {
"visitNoteId": 4,
"patientVitalId": 4,
"patientId": "4",
"employeeUid": 4,
"soapId": 4,
"surgeryId": "4",
"bcs": 123,
"weightLb": 123.45,
"weightKg": 987.65,
"heartRate": 123,
"tempF": 987.65,
"tempC": 987.65,
"resp": 123,
"bpDia": 987,
"bpSys": 123,
"crt": 123.45,
"painScore": 987,
"periodontalDisease": 987,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updatePin
Response
Returns a ClinicUserSchema!
Arguments
| Name | Description |
|---|---|
input - EmployeePinUpdateSchema!
|
Example
Query
mutation UpdatePin($input: EmployeePinUpdateSchema!) {
updatePin(input: $input) {
profilePicture {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
username
employeeExtId
jobTitle
role
rolePermission
employeeStatus
licenseNumber
deaNumber
taskFilter
hl7iProviderIds {
...Hl7iProviderIdSchemaFragment
}
ellieProviderId
antechV6ProviderId
quickPin
providerCodes
isProvider
allMessages
bypassIpRestrictionEnabled
mangoExtension
autoSignVaccineCertificates
signature
}
clientInfo {
clientExtId
familyId
clientStatus
warnings
groupDiscountId
taxExempt
}
createdAt
updatedAt
highlights {
path
texts {
...TextFragment
}
score
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
}
Variables
{"input": EmployeePinUpdateSchema}
Response
{
"data": {
"updatePin": {
"profilePicture": MediaSchema,
"id": 4,
"firstName": "xyz789",
"lastName": "abc123",
"emailH": "xyz789",
"emailW": "abc123",
"phoneH": "xyz789",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": "4",
"hideInCalendar": true,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
}
}
updatePurchaseOrder
Response
Returns a PurchaseOrderSchema!
Arguments
| Name | Description |
|---|---|
input - PurchaseOrderUpdateSchema!
|
Example
Query
mutation UpdatePurchaseOrder($input: PurchaseOrderUpdateSchema!) {
updatePurchaseOrder(input: $input) {
id
vetcoveId
creatorUid
poNumber
subtotal
tax
shipping
total
vendorId
items {
id
name
sku
unitMeasurement
quantity
treatmentId
locationId
vetcoveItemId
unitPrice
listPrice
totalPrice
units
isLinked
packType
availabilityCode
availabilityText
manufacturerName
deletedAt
receivedAt
cancelled
expiredAt
inventoryItemId
lotId
serialNo
ndcNumber
}
orderPlacementTime
status
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": PurchaseOrderUpdateSchema}
Response
{
"data": {
"updatePurchaseOrder": {
"id": "4",
"vetcoveId": 987,
"creatorUid": "4",
"poNumber": "xyz789",
"subtotal": 987,
"tax": 123,
"shipping": 987,
"total": 987,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateReminder
Response
Returns a ReminderSchema!
Arguments
| Name | Description |
|---|---|
input - ReminderUpdateSchema!
|
Example
Query
mutation UpdateReminder($input: ReminderUpdateSchema!) {
updateReminder(input: $input) {
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
vaccine {
media {
...MediaSchemaFragment
}
vaccineId
status
patientId
creatorUid
item {
...VaccineItemSchemaFragment
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
isEmailable
isSmsable
reminderId
status
patientId
refId
notes
type
creatorUid
invoiceId
dueDate
createdAt
updatedAt
}
}
Variables
{"input": ReminderUpdateSchema}
Response
{
"data": {
"updateReminder": {
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": true,
"isSmsable": true,
"reminderId": 4,
"status": "ACTIVE",
"patientId": 4,
"refId": 4,
"notes": "xyz789",
"type": "TREATMENT",
"creatorUid": 4,
"invoiceId": "4",
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateRole
Response
Returns a RoleSchema!
Arguments
| Name | Description |
|---|---|
input - RoleUpdateSchema!
|
Example
Query
mutation UpdateRole($input: RoleUpdateSchema!) {
updateRole(input: $input) {
id
name
permissions
systemRole
sisterClinics
createdAt
updatedAt
}
}
Variables
{"input": RoleUpdateSchema}
Response
{
"data": {
"updateRole": {
"id": "4",
"name": "xyz789",
"permissions": ["xyz789"],
"systemRole": false,
"sisterClinics": ["abc123"],
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateRxScript
Response
Returns a RxScriptSchema!
Arguments
| Name | Description |
|---|---|
input - RxScriptUpdateSchema!
|
Example
Query
mutation UpdateRxScript($input: RxScriptUpdateSchema!) {
updateRxScript(input: $input) {
originalRxScript {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
treatmentobj {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
Variables
{"input": RxScriptUpdateSchema}
Response
{
"data": {
"updateRxScript": {
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": 4,
"patientId": "4",
"creatorUid": "4",
"filledById": 4,
"clientId": "4",
"refId": 4,
"originalRefId": 4,
"renewedRefId": "4",
"renewedFromRefId": "4",
"treatmentId": 4,
"treatmentInstanceId": 4,
"treatment": "abc123",
"totalDosage": Decimal,
"duration": 987,
"durationUnit": "MINUTES",
"customDoseUnit": "abc123",
"isCustomTreatment": true,
"customTreatmentIsRxScript": false,
"refills": 987,
"instructions": "abc123",
"voided": true,
"voidReason": "abc123",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
}
}
updateScheduledEvent
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
input - UpdateScheduledEventSchema!
|
Example
Query
mutation UpdateScheduledEvent($input: UpdateScheduledEventSchema!) {
updateScheduledEvent(input: $input) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": UpdateScheduledEventSchema}
Response
{
"data": {
"updateScheduledEvent": {
"id": "4",
"patientId": "4",
"clientId": "4",
"providerId": "4",
"techUid": 4,
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "xyz789",
"status": "ONGOING",
"originId": 4,
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateSettings
Response
Returns a SettingsSchema!
Arguments
| Name | Description |
|---|---|
input - SettingsUpdateSchema!
|
Example
Query
mutation UpdateSettings($input: SettingsUpdateSchema!) {
updateSettings(input: $input) {
practiceId
featureFlags {
name
nameEnum
description
enabled
enabledGlobal
}
appointmentTypes {
id
creatorId
legacyKey
name
category
description
color
defaultMinutes
depositRequired
depositAmount
order
directOnlineEnabled
isRequired
sendReminderNotifications
deletedAt
createdAt
updatedAt
}
settingsId
clinicLogo {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
street
city
state
country
zipCode
name
status
email
phone
twilioPhone
timezone
clinicLogoMediaId
vetcoveConnected
tilledAccountId
officeHours {
sunday {
...OfficeHourEntrySchemaFragment
}
monday {
...OfficeHourEntrySchemaFragment
}
tuesday {
...OfficeHourEntrySchemaFragment
}
wednesday {
...OfficeHourEntrySchemaFragment
}
thursday {
...OfficeHourEntrySchemaFragment
}
friday {
...OfficeHourEntrySchemaFragment
}
saturday {
...OfficeHourEntrySchemaFragment
}
}
calendarOptions {
stepInt
allowApptDrag
allowScheduleOver
allowExperimental
bypassRequiredCheckinFields
hideCancelled
}
soapAutolockHours
surgeryAutolockHours
visitNoteAutolockHours
appAutolockMinutes
vitalsAutolockHours
taxRate
pstTaxRate
taxRateSource
prompts {
type
content
}
emailEnabled
replyToEmail
inventoryOptions {
inventoryUsagePriority
}
labIntegrationOptions {
idexxEnabled
idexxUsername
zoetisEnabled
zoetisClientId
antechV6Enabled
antechV6ClinicId
antechV6Username
ellieEnabled
ellieClinicId
hl7iOptions {
...Hl7iOptionSchemaFragment
}
autoCreateLabTreatment
autoCreateMarkupFactor
}
idexxWebpacsOptions {
username
vendorClinicId
locationTokens
enableWorkers
}
soundvetOptions {
baseUrl
clientId
secretId
callbackUrl
enableWorkers
}
mangoAuthKey
clientPortalOptions {
enabledMedicalRecords {
...MedicalHistoryOptionsSchemaFragment
}
rxRefillTaskEnabled
rxRefillTaskDefaultPriority
rxRefillTaskDueDeltaInHours
rxRefillTaskDefaultCreator
rxRefillTaskDefaultAssignee
}
directOnlineSchedulingOptions {
enabled
approvalRequired
maxDaysInAdvance
minHoursBeforeAppt
minMinutesBetweenAppt
introTitle
introContent
bookingFeePolicy
speciesAllowed
allowNewClientsOnlineAppointments
enableOnlineAppointmentsNotifications
onlineAppointmentsNotificationsEmail
}
prescriptionOptions {
enabledFilledActionShortcut
enabledAutoGeneratedSignature
}
smsAppointmentReminderOptions {
enabled
leadTimeInHours
startTime
}
isSmsTreatmentReminderEnabled
voipOptions {
enabled
greetings
forwardedPhoneNumber
}
chartOptions {
baseUrl
financeDashboardId
patientDashboardId
}
patientDeceasedOptions {
showInSearchResults
showInFamilyDropdownList
}
isRxLabelFlipped
rxLabelDimensions {
width
height
}
patientIdLabelDimensions {
width
height
}
labResultsCallbackTaskOptions {
enabled
defaultPriority
dueDeltaInHours
}
treatmentsMustBeNewerThan
createdAt
updatedAt
weightUnit
visitSummary {
soapIncludes
surgeryIncludes
visitIncludes
}
estimateExpirationDays
typesAndCategories {
type
typeCode
locked
categories {
...TreatmentCategorySchemaFragment
}
}
interestOptions {
enabled
interestRate
ageThresholdInDays
minOverdueBalance
policyText
}
pdfSettings {
alignment
invoiceForceSinglePage
}
sisterClinics
accountsReceivableLastSyncedAt
migrationDate
apiIntegrations
maintenanceMode
specialCareNotes {
patient {
...SpecialCareNoteSettingsSchemaFragment
}
client {
...SpecialCareNoteSettingsSchemaFragment
}
}
invoiceSettings {
includeRemindersOnInvoice
includeFollowUpAppointmentsOnInvoice
includeWrittenRxOnInvoice
serviceFeePercentage
includeOnlyPaidOrPartialPaidInvoicesInReport
}
estimateSettings {
includeDisclaimerOnUnapprovedEstimates
}
enableSso
ipRestrictionEnabled
clinicIpAddress
}
}
Variables
{"input": SettingsUpdateSchema}
Response
{
"data": {
"updateSettings": {
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "abc123",
"city": "xyz789",
"state": "abc123",
"country": "xyz789",
"zipCode": "abc123",
"name": "abc123",
"status": "OPEN",
"email": "abc123",
"phone": "abc123",
"twilioPhone": "xyz789",
"timezone": "xyz789",
"clinicLogoMediaId": "4",
"vetcoveConnected": false,
"tilledAccountId": "abc123",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 123,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": true,
"replyToEmail": "abc123",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "abc123",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": false,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "abc123",
"updatedAt": "abc123",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["abc123"],
"maintenanceMode": false,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
}
}
updateSmsTemplate
Response
Returns an SMSTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SMSTemplateUpdateSchema!
|
Example
Query
mutation UpdateSmsTemplate($input: SMSTemplateUpdateSchema!) {
updateSmsTemplate(input: $input) {
availableVariables
id
name
description
templateKey
body
type
linkedFormIds
createdAt
updatedAt
deletedAt
}
}
Variables
{"input": SMSTemplateUpdateSchema}
Response
{
"data": {
"updateSmsTemplate": {
"availableVariables": {},
"id": "4",
"name": "abc123",
"description": "abc123",
"templateKey": "abc123",
"body": "abc123",
"type": "AUTOMATED",
"linkedFormIds": [4],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
}
}
updateSoap
Response
Returns an UpdatedSoapResponse!
Arguments
| Name | Description |
|---|---|
input - SoapUpdateSchema!
|
|
meta - SoapUpdateMetaSchema
|
Default = null |
Example
Query
mutation UpdateSoap(
$input: SoapUpdateSchema!,
$meta: SoapUpdateMetaSchema
) {
updateSoap(
input: $input,
meta: $meta
) {
updatedSoap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
syncedInvoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
}
Variables
{"input": SoapUpdateSchema, "meta": null}
Response
{
"data": {
"updateSoap": {
"updatedSoap": SoapSchema,
"syncedInvoice": InvoiceSchema
}
}
}
updateSoapTemplate
Response
Returns a SoapTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SoapTemplateUpdateSchema!
|
Example
Query
mutation UpdateSoapTemplate($input: SoapTemplateUpdateSchema!) {
updateSoapTemplate(input: $input) {
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
id
creatorId
name
species
appointmentTypeId
isDeleted
favoritedBy
soapTemplateData {
treatments {
...TreatmentSchemaFragment
}
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
recs
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SoapTemplateUpdateSchema}
Response
{
"data": {
"updateSoapTemplate": {
"appointmentType": AppointmentTypeResolveSchema,
"id": 4,
"creatorId": "4",
"name": "abc123",
"species": "abc123",
"appointmentTypeId": 4,
"isDeleted": false,
"favoritedBy": ["4"],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateSpecialCareNote
Response
Returns a SpecialCareNoteSchema!
Arguments
| Name | Description |
|---|---|
input - SpecialCareNoteUpdateSchema!
|
Example
Query
mutation UpdateSpecialCareNote($input: SpecialCareNoteUpdateSchema!) {
updateSpecialCareNote(input: $input) {
createdByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
updatedByUser {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
resource {
... on PatientSchema {
...PatientSchemaFragment
}
... on ClinicUserSchema {
...ClinicUserSchemaFragment
}
}
id
resourceId
resourceType
createdBy
updatedBy
note
noteType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": SpecialCareNoteUpdateSchema}
Response
{
"data": {
"updateSpecialCareNote": {
"createdByUser": ClinicUserSchema,
"updatedByUser": ClinicUserSchema,
"resource": PatientSchema,
"id": 4,
"resourceId": "4",
"resourceType": "PATIENT",
"createdBy": 4,
"updatedBy": 4,
"note": "xyz789",
"noteType": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateSpecies
Response
Returns a SpeciesSchema!
Arguments
| Name | Description |
|---|---|
input - SpeciesUpdateSchema!
|
Example
Query
mutation UpdateSpecies($input: SpeciesUpdateSchema!) {
updateSpecies(input: $input) {
id
species
imageData
createdAt
updatedAt
custom
}
}
Variables
{"input": SpeciesUpdateSchema}
Response
{
"data": {
"updateSpecies": {
"id": "4",
"species": "xyz789",
"imageData": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"custom": false
}
}
}
updateSubscription
Response
Returns a SubscriptionSchema!
Arguments
| Name | Description |
|---|---|
input - UpdateSubscriptionInput!
|
Example
Query
mutation UpdateSubscription($input: UpdateSubscriptionInput!) {
updateSubscription(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
family {
familyId
familyName
primaryContactUid
secondaryContactUid
clients
patients
balanceAmount
storeCreditBalance
status
familyExtId
createdAt
updatedAt
lastReminderSentAt
}
id
accountId
customerId
status
price
currency
intervalUnit
intervalCount
paymentMethodId
platformFeeAmount
canceledAt
cancelAt
billingCycleAnchor
pausedAt
resumeAt
pauseAt
nextPaymentAt
metadata
createdAt
updatedAt
}
}
Variables
{"input": UpdateSubscriptionInput}
Response
{
"data": {
"updateSubscription": {
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "xyz789",
"accountId": "xyz789",
"customerId": "xyz789",
"status": "ACTIVE",
"price": 987,
"currency": "AUD",
"intervalUnit": "xyz789",
"intervalCount": 123,
"paymentMethodId": "abc123",
"platformFeeAmount": 987,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateSurgery
Response
Returns an UpdatedSurgeryNoteResponse!
Arguments
| Name | Description |
|---|---|
input - SurgeryUpdateSchema!
|
|
meta - SurgeryUpdateMetaSchema
|
Default = null |
Example
Query
mutation UpdateSurgery(
$input: SurgeryUpdateSchema!,
$meta: SurgeryUpdateMetaSchema
) {
updateSurgery(
input: $input,
meta: $meta
) {
updatedSurgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
syncedInvoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
}
Variables
{"input": SurgeryUpdateSchema, "meta": null}
Response
{
"data": {
"updateSurgery": {
"updatedSurgery": SurgerySchema,
"syncedInvoice": InvoiceSchema
}
}
}
updateSurgeryTemplate
Response
Returns a SurgeryTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - SurgeryTemplateUpdateSchema!
|
Example
Query
mutation UpdateSurgeryTemplate($input: SurgeryTemplateUpdateSchema!) {
updateSurgeryTemplate(input: $input) {
id
name
creatorId
species
isDeleted
favoritedBy
surgeryTemplateData {
treatments {
...TreatmentSchemaFragment
}
procedure
preopNotes
intraopMedicationNotes
intraopProcedureNotes
postopNotes
treatmentIds
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
}
createdAt
updatedAt
}
}
Variables
{"input": SurgeryTemplateUpdateSchema}
Response
{
"data": {
"updateSurgeryTemplate": {
"id": "4",
"name": "xyz789",
"creatorId": "4",
"species": "abc123",
"isDeleted": true,
"favoritedBy": ["4"],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateSurgeryVital
Response
Returns a SurgeryVitalSchema!
Arguments
| Name | Description |
|---|---|
input - SurgeryVitalUpdateSchema!
|
Example
Query
mutation UpdateSurgeryVital($input: SurgeryVitalUpdateSchema!) {
updateSurgeryVital(input: $input) {
id
name
order
}
}
Variables
{"input": SurgeryVitalUpdateSchema}
Response
{
"data": {
"updateSurgeryVital": {
"id": 4,
"name": "abc123",
"order": 987
}
}
}
updateTask
Response
Returns a TaskSchema!
Arguments
| Name | Description |
|---|---|
input - TaskUpdateSchema!
|
Example
Query
mutation UpdateTask($input: TaskUpdateSchema!) {
updateTask(input: $input) {
id
patientId
clientId
creatorId
assignedById
assigneeId
taskType
priority
status
description
dueAt
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": TaskUpdateSchema}
Response
{
"data": {
"updateTask": {
"id": 4,
"patientId": 4,
"clientId": "4",
"creatorId": "4",
"assignedById": "4",
"assigneeId": 4,
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "xyz789",
"dueAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateTerminal
Response
Returns a TerminalReaderSchema!
Arguments
| Name | Description |
|---|---|
input - TerminalUpdateSchema!
|
Example
Query
mutation UpdateTerminal($input: TerminalUpdateSchema!) {
updateTerminal(input: $input) {
id
accountId
type
serialNumber
description
createdAt
updatedAt
}
}
Variables
{"input": TerminalUpdateSchema}
Response
{
"data": {
"updateTerminal": {
"id": "xyz789",
"accountId": "xyz789",
"type": "abc123",
"serialNumber": "xyz789",
"description": "xyz789",
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateTransaction
Response
Returns a TransactionSchema!
Arguments
| Name | Description |
|---|---|
input - TransactionUpdateSchema!
|
Example
Query
mutation UpdateTransaction($input: TransactionUpdateSchema!) {
updateTransaction(input: $input) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"input": TransactionUpdateSchema}
Response
{
"data": {
"updateTransaction": {
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": 4,
"familyId": "4",
"clientId": 4,
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 987,
"invoiceId": "4",
"voidedTransactionId": 4,
"otherInvoiceIds": ["4"],
"otherTransactionIds": ["4"],
"partialVoid": false,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "abc123",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": true
}
}
}
updateTreatment
Response
Returns a TreatmentSchema!
Arguments
| Name | Description |
|---|---|
input - TreatmentUpdateSchema!
|
Example
Query
mutation UpdateTreatment($input: TreatmentUpdateSchema!) {
updateTreatment(input: $input) {
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
treatmentId
relativeDueTime
}
satisfyReminders {
treatmentId
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
rate
threshold
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
treatmentId
quantity
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
}
Variables
{"input": TreatmentUpdateSchema}
Response
{
"data": {
"updateTreatment": {
"dischargeDocuments": [DischargeDocumentSchema],
"treatmentId": "4",
"name": "abc123",
"unit": "ML",
"pricePerUnit": 987,
"instructions": "xyz789",
"adminFee": 123,
"minimumCharge": 987,
"customDoseUnit": "abc123",
"duration": 987,
"durUnit": "MINUTES",
"refills": 123,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"dischargeDocumentIds": ["4"],
"type": "xyz789",
"typeCode": "xyz789",
"category": "xyz789",
"categoryCode": "xyz789",
"subCategory": "abc123",
"subCategoryCode": "xyz789",
"isTaxable": false,
"isPstTaxable": true,
"isDiscountable": false,
"isControlledSubstance": true,
"generateReminders": [
TreatmentReminderGenerateSchema
],
"satisfyReminders": [
TreatmentReminderSatisfySchema
],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"deactivatePatientOnCheckout": false,
"spayPatientOnCheckout": true,
"useHistoricalHigh": false,
"discountRates": [DiscountRateSchema],
"isProvisional": true,
"useAsDefaultNoProvisional": true,
"labCat": "IN_HOUSE",
"labCode": "xyz789",
"labDevice": "abc123",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "abc123",
"inventoryEnabled": true,
"inventoryTreatmentId": 4,
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": true,
"compoundInventoryItems": [
CompoundInventoryItemSchema
],
"vetcoveEnabled": true,
"minimumQuantity": Decimal,
"quantityRemaining": Decimal,
"furthestExpiredAt": "abc123",
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 123,
"clinicCostPerUnit": 987,
"useVendorCost": false,
"vendorListPrice": 123,
"route": "ORAL",
"freq": "abc123",
"manufacturer": "abc123",
"vaccine": "xyz789",
"lotNo": "xyz789",
"expDate": datetime,
"species": "abc123",
"dose": Decimal
}
}
}
updateTreatmentPlan
Response
Returns a TreatmentPlanSchema!
Arguments
| Name | Description |
|---|---|
input - TreatmentPlanUpdateSchema!
|
Example
Query
mutation UpdateTreatmentPlan($input: TreatmentPlanUpdateSchema!) {
updateTreatmentPlan(input: $input) {
id
patientId
clientId
providerId
techUid
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
tasks {
id
name
description
scheduledEvents {
...ScheduledEventSchemaFragment
}
}
description
status
originId
originType
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": TreatmentPlanUpdateSchema}
Response
{
"data": {
"updateTreatmentPlan": {
"id": "4",
"patientId": 4,
"clientId": "4",
"providerId": 4,
"techUid": 4,
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateVaccine
Response
Returns a VaccineSchema!
Arguments
| Name | Description |
|---|---|
input - VaccineUpdateSchema!
|
Example
Query
mutation UpdateVaccine($input: VaccineUpdateSchema!) {
updateVaccine(input: $input) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
vaccineId
status
patientId
creatorUid
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
}
Variables
{"input": VaccineUpdateSchema}
Response
{
"data": {
"updateVaccine": {
"media": MediaSchema,
"vaccineId": "4",
"status": "OPEN",
"patientId": "4",
"creatorUid": 4,
"item": VaccineItemSchema,
"approved": false,
"declined": true,
"vaccinationDate": "abc123",
"expDate": "abc123",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"invoiceId": "4",
"clientId": "4",
"tagNumber": "abc123",
"previousTagNumber": "xyz789",
"approverId": "4",
"approverName": "xyz789",
"approverLicense": "xyz789",
"signature": "xyz789",
"mediaRef": "4",
"originalVaccineId": 4,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
updateVendor
Response
Returns a VendorSchema!
Arguments
| Name | Description |
|---|---|
input - VendorUpdateSchema!
|
Example
Query
mutation UpdateVendor($input: VendorUpdateSchema!) {
updateVendor(input: $input) {
id
name
contactName
contactEmail
vetcoveId
type
accountNumber
website
deletedAt
}
}
Variables
{"input": VendorUpdateSchema}
Response
{
"data": {
"updateVendor": {
"id": 4,
"name": "xyz789",
"contactName": "xyz789",
"contactEmail": "xyz789",
"vetcoveId": 123,
"type": "MANUFACTURER",
"accountNumber": "abc123",
"website": "xyz789",
"deletedAt": datetime
}
}
}
updateVisitNote
Response
Returns an UpdatedVisitNoteResponse!
Arguments
| Name | Description |
|---|---|
input - VisitNoteUpdateSchema!
|
|
meta - CommonNoteUpdateMetaSchema
|
Default = null |
Example
Query
mutation UpdateVisitNote(
$input: VisitNoteUpdateSchema!,
$meta: CommonNoteUpdateMetaSchema
) {
updateVisitNote(
input: $input,
meta: $meta
) {
updatedVisitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
syncedInvoice {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
}
Variables
{"input": VisitNoteUpdateSchema, "meta": null}
Response
{
"data": {
"updateVisitNote": {
"updatedVisitNote": VisitNoteSchema,
"syncedInvoice": InvoiceSchema
}
}
}
updateVisitNoteTemplate
Response
Returns a VisitNoteTemplateSchema!
Arguments
| Name | Description |
|---|---|
input - VisitNoteTemplateUpdateSchema!
|
Example
Query
mutation UpdateVisitNoteTemplate($input: VisitNoteTemplateUpdateSchema!) {
updateVisitNoteTemplate(input: $input) {
id
name
creatorId
species
isDeleted
favoritedBy
appointmentTypeId
visitNoteTemplateData {
treatments {
...TreatmentSchemaFragment
}
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
treatmentIds
}
createdAt
updatedAt
}
}
Variables
{"input": VisitNoteTemplateUpdateSchema}
Response
{
"data": {
"updateVisitNoteTemplate": {
"id": 4,
"name": "abc123",
"creatorId": "4",
"species": "xyz789",
"isDeleted": true,
"favoritedBy": ["4"],
"appointmentTypeId": "4",
"visitNoteTemplateData": VisitNoteTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
updateWorkflowAutomation
Response
Returns a WorkflowAutomation!
Arguments
| Name | Description |
|---|---|
input - WorkflowAutomationUpdateInput!
|
Example
Query
mutation UpdateWorkflowAutomation($input: WorkflowAutomationUpdateInput!) {
updateWorkflowAutomation(input: $input) {
pendingExecutionsCount
id
name
description
status
createdBy
clinicId
triggers {
type
operator
conditions {
...WorkflowAutomationConditionsFragment
}
}
triggerLogic
actions {
type
timing {
...ActionTimingFragment
}
config {
...WorkflowAutomationActionConfigFragment
}
}
instanceId
createdAt
updatedAt
updatedBy
}
}
Variables
{"input": WorkflowAutomationUpdateInput}
Response
{
"data": {
"updateWorkflowAutomation": {
"pendingExecutionsCount": 987,
"id": 4,
"name": "abc123",
"description": "abc123",
"status": "ACTIVE",
"createdBy": "4",
"clinicId": 4,
"triggers": [WorkflowAutomationTrigger],
"triggerLogic": "AND",
"actions": [WorkflowAutomationAction],
"instanceId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"updatedBy": "4"
}
}
}
updateXray
Response
Returns a XraySchema!
Arguments
| Name | Description |
|---|---|
input - XrayUpdateSchema!
|
Example
Query
mutation UpdateXray($input: XrayUpdateSchema!) {
updateXray(input: $input) {
resultUrl
treatment {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
surgery {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
procedure
preop {
...PreopSchemaFragment
}
intraop {
...IntraopSchemaFragment
}
postop {
...PostopSchemaFragment
}
recordedSurgeryVitals {
...RecordedSurgeryVitalSchemaFragment
}
}
soap {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
soapId
vetUid
voiceNoteId
details
subjective
objective {
...SoapObjectiveSchemaFragment
}
assessment {
...SoapAssessmentSchemaFragment
}
recs
forms
voiceNoteApprovedSignature
}
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
orderNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
notes
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
treatmentId
patientId
soapId
surgeryId
visitNoteId
orderNoteId
isStaff
providerId
status
notes
deletedAt
createdAt
updatedAt
}
}
Variables
{"input": XrayUpdateSchema}
Response
{
"data": {
"updateXray": {
"resultUrl": "xyz789",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": 4,
"treatmentId": 4,
"patientId": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"notes": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
}
}
voidCommonNote
Response
Returns a CommonNoteSchema!
Arguments
| Name | Description |
|---|---|
input - CommonNoteVoidSchema!
|
Example
Query
mutation VoidCommonNote($input: CommonNoteVoidSchema!) {
voidCommonNote(input: $input) {
patientVitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
estimates {
soap {
...SoapSchemaFragment
}
estimateId
status
patientId
creatorUid
soapId
surgeryId
visitNoteId
orderNoteId
items {
...EstimateItemSchemaFragment
}
isRange
minSubtotal
maxSubtotal
isTaxExempt
minTax
maxTax
minPstTax
maxPstTax
taxRate
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
minTotal
maxTotal
approved
approvalMethod
signature
clientId
otherApproverName
media {
...MediaSchemaFragment
}
title
expirationDate
createdAt
updatedAt
}
invoices {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
vitals {
visitNoteId
patientVitalId
patientId
employeeUid
soapId
surgeryId
bcs
weightLb
weightKg
heartRate
tempF
tempC
resp
bpDia
bpSys
crt
painScore
periodontalDisease
createdAt
updatedAt
}
addendums {
creator {
...ClinicUserSchemaFragment
}
id
refId
refType
creatorId
description
timestamp
deletedAt
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
creator {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
provider {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
tech {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
appointmentType {
id
name
color
category
depositAmount
deletedAt
}
dischargeDocuments {
linkedDiagnoses {
...DiagnosisBasicSchemaFragment
}
linkedTreatments {
...TreatmentBasicSchemaFragment
}
id
fileName
documentName
mediaId
species
creatorId
deletedAt
createdAt
updatedAt
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
useVendorCost
vendorListPrice
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
declined
filledById
prescribedById
prescribedAt
expiresAt
labId
xrayId
vaccineId
scheduledEvents {
...ScheduledEventSchemaFragment
}
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
qty
customDoseUnit
route
freq
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
rxScriptId
dischargeDocumentIds
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
dose
createdAt
}
followUps {
appointmentTypeId
reason
beforeDatetime
createdAt
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
media {
...MediaSchemaFragment
}
id
title
species
type
mediaId
nectarDefault
canvasJson
creatorId
createdAt
annotations {
...SoapSurgeryPatientDiagramAnnotationSchemaFragment
}
}
}
}
Variables
{"input": CommonNoteVoidSchema}
Response
{
"data": {
"voidCommonNote": {
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": "4",
"techUid": 4,
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [SoapSurgeryPatientDiagramSchema]
}
}
}
voidCommunication
Response
Returns a CommunicationSchema!
Arguments
| Name | Description |
|---|---|
input - CommunicationVoidSchema!
|
Example
Query
mutation VoidCommunication($input: CommunicationVoidSchema!) {
voidCommunication(input: $input) {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
patient {
otherPatients {
...PatientSchemaFragment
}
profilePicture {
...MediaSchemaFragment
}
hasActiveCheckout
family {
...FamilyViewSchemaFragment
}
patientId
extId
familyId
contactUid
firstName
status
species
lastName
breed
dateOfBirth
dateOfDeath
color
weightLbs
weightKg
gender
spayNeuter
photoUrl
warnings
microchip
chatSessions {
...ChatSessionSchemaFragment
}
meta {
...MetaSchemaFragment
}
highlights {
...HighlightFragment
}
profilePictureMediaId
patientBreed {
...BreedSchemaFragment
}
speciesInfo {
...SpeciesSchemaFragment
}
contact {
...ClinicUserSchemaFragment
}
createdVia
patientVitals {
...PatientVitalSchemaFragment
}
indexedAt
firstInvoiceDate
lastInvoiceDate
createdAt
updatedAt
}
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
callAnalytics {
summary
sentiment
transcript
}
communicationId
clientId
patientId
employeeId
communicationType
communication
contactDatetime
status
mediaId
mangoWebhookRequestId
voidReason
createdAt
updatedAt
}
}
Variables
{"input": CommunicationVoidSchema}
Response
{
"data": {
"voidCommunication": {
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"patient": PatientSchema,
"media": MediaSchema,
"callAnalytics": CallSummaryAnalyticsSchema,
"communicationId": "4",
"clientId": "4",
"patientId": "4",
"employeeId": "4",
"communicationType": "PHONE",
"communication": "abc123",
"contactDatetime": datetime,
"status": "OPEN",
"mediaId": "4",
"mangoWebhookRequestId": "abc123",
"voidReason": "abc123",
"createdAt": datetime,
"updatedAt": datetime
}
}
}
voidInvoice
Response
Returns an InvoiceSchema!
Arguments
| Name | Description |
|---|---|
input - InvoiceVoidSchema!
|
Example
Query
mutation VoidInvoice($input: InvoiceVoidSchema!) {
voidInvoice(input: $input) {
invoiceId
patientId
status
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
treatment {
...TreatmentSchemaFragment
}
treatmentId
instanceId
name
unit
pricePerUnit
adminFee
minimumCharge
isTaxable
isPstTaxable
instructions
customPrice
discountRates {
...DiscountRateSchemaFragment
}
labId
vaccineId
priceType
markupFactor
inventoryEnabled
useHistoricalHigh
nonBillable
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
groupDiscount {
...ItemGroupDiscountSchemaFragment
}
isCustomTreatment
customTreatmentIsRxScript
clinicCostPerUnit
useVendorCost
vendorListPrice
inventoryLotId
inventoryManufacturer
parentBundleInfo {
...ParentBundleInfoSchemaFragment
}
hideItem
providerId
providerCode
qty
hasDiscount
dayOfService
cost
clinicCost
discount
subtotal
tax
pstTax
deactivatePatientOnCheckout
spayPatientOnCheckout
refunded
voidedAmount
isDiscountable
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
invoicedAt
title
isInterestCharge
isMigrated
createdAt
updatedAt
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
paymentStatus
shortInvoiceId
}
}
Variables
{"input": InvoiceVoidSchema}
Response
{
"data": {
"voidInvoice": {
"invoiceId": 4,
"patientId": "4",
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"estimateId": "4",
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": true,
"tax": 123,
"taxRate": 987.65,
"pstTax": 987,
"pstTaxRate": 123.45,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 987,
"total": 123,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "xyz789",
"invoicedAt": datetime,
"title": "xyz789",
"isInterestCharge": true,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 123,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123"
}
}
}
voidRxScript
Response
Returns a RxScriptSchema!
Arguments
| Name | Description |
|---|---|
input - RxScriptVoidSchema!
|
Example
Query
mutation VoidRxScript($input: RxScriptVoidSchema!) {
voidRxScript(input: $input) {
originalRxScript {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
mostRecentRefill {
treatmentobj {
...TreatmentSchemaFragment
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
treatmentId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
treatmentobj {
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
treatmentId
name
unit
pricePerUnit
instructions
adminFee
minimumCharge
customDoseUnit
duration
durUnit
refills
beforeDatetime
fulfill
markupFactor
priceType
dischargeDocumentIds
type
typeCode
category
categoryCode
subCategory
subCategoryCode
isTaxable
isPstTaxable
isDiscountable
isControlledSubstance
generateReminders {
...TreatmentReminderGenerateSchemaFragment
}
satisfyReminders {
...TreatmentReminderSatisfySchemaFragment
}
createdAt
updatedAt
deletedAt
deactivatePatientOnCheckout
spayPatientOnCheckout
useHistoricalHigh
discountRates {
...DiscountRateSchemaFragment
}
isProvisional
useAsDefaultNoProvisional
labCat
labCode
labDevice
labVendor
xrayVendor
xrayModality
inventoryEnabled
inventoryTreatmentId
multiplier
treatmentInventoryOptionEnabled
compoundInventoryItems {
...CompoundInventoryItemSchemaFragment
}
vetcoveEnabled
minimumQuantity
quantityRemaining
furthestExpiredAt
inventoryHistoricalHighCostPerUnit
inventoryLatestCostPerUnit
clinicCostPerUnit
useVendorCost
vendorListPrice
route
freq
manufacturer
vaccine
lotNo
expDate
species
dose
}
rxScriptId
patientId
creatorUid
filledById
clientId
refId
originalRefId
renewedRefId
renewedFromRefId
treatmentId
treatmentInstanceId
treatment
totalDosage
duration
durationUnit
customDoseUnit
isCustomTreatment
customTreatmentIsRxScript
refills
instructions
voided
voidReason
beginsAt
expiresAt
updatedAt
createdAt
beforeDatetime
}
}
Variables
{"input": RxScriptVoidSchema}
Response
{
"data": {
"voidRxScript": {
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": 4,
"patientId": "4",
"creatorUid": 4,
"filledById": 4,
"clientId": 4,
"refId": 4,
"originalRefId": 4,
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": 4,
"treatmentInstanceId": "4",
"treatment": "abc123",
"totalDosage": Decimal,
"duration": 123,
"durationUnit": "MINUTES",
"customDoseUnit": "xyz789",
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"refills": 987,
"instructions": "abc123",
"voided": false,
"voidReason": "xyz789",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
}
}
voidTransaction
Response
Returns a TransactionSchema!
Arguments
| Name | Description |
|---|---|
input - TransactionVoidSchema!
|
Example
Query
mutation VoidTransaction($input: TransactionVoidSchema!) {
voidTransaction(input: $input) {
family {
id
familyId
familyName
familyNameLowercase
familyExtId
createdAt
updatedAt
balanceAmount
storeCreditBalance
status
primaryContactUid
secondaryContactUid
primaryContact {
...ClinicUserSchemaFragment
}
secondaryContact {
...ClinicUserSchemaFragment
}
clients {
...ClinicUserSchemaFragment
}
patients {
...PatientSchemaFragment
}
lastReminderSentAt
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
invoice {
soap {
...SoapSchemaFragment
}
surgery {
...SurgerySchemaFragment
}
visitNote {
...VisitNoteSchemaFragment
}
orderNote {
...OrderNoteSchemaFragment
}
id
invoiceId
status
patientId
clientId
creatorUid
voidedUid
soapId
surgeryId
visitNoteId
orderNoteId
estimateId
parentInvoiceId
items {
...InvoiceItemSchemaFragment
}
subtotal
isTaxExempt
tax
taxRate
pstTax
pstTaxRate
clientTaxRate
taxRateSource
fees
serviceFee
discount
total
totalPaid
totalInvoiceVoid
totalPaymentCancelled
outstandingBalance
accountBalanceApplied
accountBalanceManuallySet
storeCreditApplied
storeCreditManuallySet
voidedAt
notes
patient {
...PatientSchemaFragment
}
client {
...ClinicUserSchemaFragment
}
family {
...FamilySchemaFragment
}
title
isInterestCharge
isMigrated
paymentStatus
shortInvoiceId
createdAt
updatedAt
invoicedAt
}
isInterestCharge
transactionId
familyId
clientId
creatorUid
transactionType
refType
amount
invoiceId
voidedTransactionId
otherInvoiceIds
otherTransactionIds
partialVoid
method
network
notes
paymentIntentId
refundId
createdAt
balanceAmount
isManualPartialRefund
}
}
Variables
{"input": TransactionVoidSchema}
Response
{
"data": {
"voidTransaction": {
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": "4",
"familyId": 4,
"clientId": "4",
"creatorUid": "4",
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": "4",
"voidedTransactionId": "4",
"otherInvoiceIds": ["4"],
"otherTransactionIds": [4],
"partialVoid": false,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "abc123",
"createdAt": datetime,
"balanceAmount": 123,
"isManualPartialRefund": true
}
}
}
voidVaccine
Response
Returns a VaccineSchema!
Arguments
| Name | Description |
|---|---|
input - VaccineUpdateSchema!
|
Example
Query
mutation VoidVaccine($input: VaccineUpdateSchema!) {
voidVaccine(input: $input) {
media {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
vaccineId
status
patientId
creatorUid
item {
treatment {
...TreatmentSchemaFragment
}
name
unit
pricePerUnit
clinicCostPerUnit
qty
treatmentId
instanceId
species
manufacturer
vaccine
lotNo
serialNo
expDate
}
approved
declined
vaccinationDate
expDate
soapId
surgeryId
visitNoteId
orderNoteId
invoiceId
clientId
tagNumber
previousTagNumber
approverId
approverName
approverLicense
signature
mediaRef
originalVaccineId
createdAt
updatedAt
}
}
Variables
{"input": VaccineUpdateSchema}
Response
{
"data": {
"voidVaccine": {
"media": MediaSchema,
"vaccineId": 4,
"status": "OPEN",
"patientId": 4,
"creatorUid": "4",
"item": VaccineItemSchema,
"approved": false,
"declined": false,
"vaccinationDate": "abc123",
"expDate": "abc123",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": 4,
"invoiceId": "4",
"clientId": "4",
"tagNumber": "xyz789",
"previousTagNumber": "abc123",
"approverId": "4",
"approverName": "abc123",
"approverLicense": "abc123",
"signature": "abc123",
"mediaRef": 4,
"originalVaccineId": "4",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
}
}
Subscriptions
call
Response
Returns an IncomingCallSchema!
Example
Query
subscription Call {
call {
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
phoneNumber
}
}
Response
{
"data": {
"call": {
"client": ClinicUserSchema,
"phoneNumber": "xyz789"
}
}
}
conversationMessageUpdates
Response
Returns a ConversationMessageSchema!
Arguments
| Name | Description |
|---|---|
conversationId - ID!
|
Example
Query
subscription ConversationMessageUpdates($conversationId: ID!) {
conversationMessageUpdates(conversationId: $conversationId) {
updateType
conversation {
assignedParticipants {
...ConversationParticipantSchemaFragment
}
updateType
participants {
...ConversationParticipantSchemaFragment
}
messages {
...ConversationMessageSchemaConnectionFragment
}
client {
...ClinicUserSchemaFragment
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
employee {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
medias {
url
signedPostUrl
bucket
visitNote {
...VisitNoteSchemaFragment
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
id
messageType
createdAt
updatedAt
fromPhoneNumber
toPhoneNumber
conversationId
body
mediaIds
patientHistoryItemIds
employeeId
status
}
}
Variables
{"conversationId": "4"}
Response
{
"data": {
"conversationMessageUpdates": {
"updateType": "NEW",
"conversation": ConversationSchema,
"employee": ClinicUserSchema,
"medias": [MediaSchema],
"id": 4,
"messageType": "SMS",
"createdAt": datetime,
"updatedAt": datetime,
"fromPhoneNumber": "xyz789",
"toPhoneNumber": "abc123",
"conversationId": "4",
"body": "abc123",
"mediaIds": ["4"],
"patientHistoryItemIds": [4],
"employeeId": "4",
"status": "ACCEPTED"
}
}
}
conversationUpdates
Response
Returns a ConversationSchema!
Arguments
| Name | Description |
|---|---|
employeeId - ID!
|
Example
Query
subscription ConversationUpdates($employeeId: ID!) {
conversationUpdates(employeeId: $employeeId) {
assignedParticipants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
updateType
participants {
employee {
...ClinicUserSchemaFragment
}
employeeId
assignedAt
assignedMessageId
readAt
unreadCount
}
messages {
pageInfo {
...PageInfoFragment
}
edges {
...ConversationMessageSchemaEdgeFragment
}
}
client {
profilePicture {
...MediaSchemaFragment
}
id
firstName
lastName
emailH
emailW
phoneH
phoneW
phoneHType
phoneWType
street
city
state
zipCode
dateOfBirth
gender
tilledCustomerId
employeeInfo {
...EmployeeInfoSchemaFragment
}
clientInfo {
...ClientInfoSchemaFragment
}
createdAt
updatedAt
highlights {
...HighlightFragment
}
profilePictureMediaId
hideInCalendar
calendarOrder
smsConsent
medicalHistoryFilters
preferredCommunicationMethods
lastReminderSentAt
createdVia
firstInvoiceDate
lastInvoiceDate
}
id
createdAt
updatedAt
clientId
unknownPhoneNumber
isArchived
readAt
unreadCount
lastMessageAt
lastSavedAt
}
}
Variables
{"employeeId": 4}
Response
{
"data": {
"conversationUpdates": {
"assignedParticipants": [
ConversationParticipantSchema
],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": 4,
"unknownPhoneNumber": "abc123",
"isArchived": true,
"readAt": datetime,
"unreadCount": 987,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
}
}
count
Response
Returns an Int!
Example
Query
subscription Count {
count
}
Response
{"data": {"count": 123}}
dataChanges
Response
Returns a DataChange!
Example
Query
subscription DataChanges {
dataChanges {
type
documentId
}
}
Response
{"data": {"dataChanges": {"type": "TREATMENT", "documentId": 4}}}
hasGlobalUnreadMessagesUpdates
hasPendingAppointmentRequests
Response
Returns a Boolean!
Example
Query
subscription HasPendingAppointmentRequests {
hasPendingAppointmentRequests
}
Response
{"data": {"hasPendingAppointmentRequests": true}}
hasUnreadMessagesUpdates
pdfTaskStatus
Response
Returns a MediaSchema!
Example
Query
subscription PdfTaskStatus {
pdfTaskStatus {
url
signedPostUrl
bucket
visitNote {
patientVitals {
...PatientVitalSchemaFragment
}
estimates {
...EstimateSchemaFragment
}
invoices {
...InvoiceViewSchemaFragment
}
vitals {
...PatientVitalSchemaFragment
}
addendums {
...AddendumSchemaFragment
}
media {
...MediaSchemaFragment
}
creator {
...ClinicUserSchemaFragment
}
provider {
...ClinicUserSchemaFragment
}
tech {
...ClinicUserSchemaFragment
}
patient {
...PatientSchemaFragment
}
appointmentType {
...AppointmentTypeResolveSchemaFragment
}
dischargeDocuments {
...DischargeDocumentSchemaFragment
}
id
noteType
patientId
providerId
creatorUid
techUid
appointmentId
appointmentTypeId
treatments {
...PrescribedTreatmentSchemaFragment
}
followUps {
...FollowUpSchemaFragment
}
status
createdAt
updatedAt
autolockCreatedAt
patientDiagrams {
...SoapSurgeryPatientDiagramSchemaFragment
}
vet {
...ClinicUserSchemaFragment
}
voiceNoteId
notes
details
recs
assessment {
...SoapAssessmentSchemaFragment
}
}
id
resourceId
resourceType
groupType
status
statusInfo
filename
deletedAt
title
description
summaryGeneratedByAi
transcript
key
createdAt
updatedAt
}
}
Response
{
"data": {
"pdfTaskStatus": {
"url": "xyz789",
"signedPostUrl": "abc123",
"bucket": "abc123",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": 4,
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "abc123",
"filename": "xyz789",
"deletedAt": "abc123",
"title": "xyz789",
"description": "abc123",
"summaryGeneratedByAi": false,
"transcript": "abc123",
"key": "xyz789",
"createdAt": "abc123",
"updatedAt": "abc123"
}
}
}
Types
AccountsReceivableSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
clientId - String
|
Primary contact's ID from the family (connects to ClinicUser model). This is the primary_contact_uid from the Family model. Required field - populated from family's primary contact during sync |
firstName - String
|
First name of the primary contact (from ClinicUser model). Synced from primary_client.first_name during accounts receivable sync. Required field - used for display and identification |
lastName - String
|
Last name of the primary contact (from ClinicUser model). Synced from primary_client.last_name during accounts receivable sync. Required field - used for display and identification |
status - FamilyStatus!
|
Family account status (from Family model). Can be ACTIVE, WRITTEN_OFF, or SENT_TO_COLLECTIONS. Affects whether reminders are sent and how the account is treated |
email - String
|
Primary contact's email address (from ClinicUser model). Synced from primary_client.email_h during accounts receivable sync. Used for sending statements and payment reminders |
phone - String
|
Primary contact's phone number (from ClinicUser model). Synced from primary_client.phone_h during accounts receivable sync. Used for contact purposes and phone-based reminders |
current - Int
|
Outstanding balance for transactions aged 0-29 days (stored as integer cents). Calculated as (debits - credits) for transactions created within the last 30 days. Excludes ACCOUNT_BALANCE payment method transactions. Balance for 0-29 days |
thirtyDays - Int
|
Outstanding balance for transactions aged 30-59 days (stored as integer cents). Calculated as (debits - credits) for transactions created 30-60 days ago. Excludes ACCOUNT_BALANCE payment method transactions. Balance for 30-59 days |
sixtyDays - Int
|
Outstanding balance for transactions aged 60-89 days (stored as integer cents). Calculated as (debits - credits) for transactions created 60-90 days ago. Excludes ACCOUNT_BALANCE payment method transactions. Balance for 60-89 days |
ninetyDays - Int
|
Outstanding balance for transactions aged 90+ days (stored as integer cents). Calculated as (debits - credits) for transactions created more than 90 days ago. Excludes ACCOUNT_BALANCE payment method transactions. Balance for 90+ days |
totalDue - Int
|
Total amount due across all aging buckets (stored as integer cents). Populated from the last_balance_amount of the family's transactions. Required field - represents the current total outstanding balance |
lastPaymentDate - datetime
|
Date of the most recent payment (CREDIT transaction) from this client. Aggregated from Transaction model where transaction_type=CREDIT. Used to track payment history and identify accounts with no recent payments |
lastStatementDate - datetime
|
Date of the most recent statement/invoice generated for this client. Aggregated from Transaction model where ref_type=INVOICE. Used to determine when the next statement should be sent |
lastReminderSentAt - datetime
|
Timestamp of when the last payment reminder was sent to this client. Synced from primary_client.last_reminder_sent_at (ClinicUser model). Used to prevent sending reminders too frequently |
deletedAt - datetime
|
Soft delete timestamp - when set, this record is considered deleted. Used for maintaining data history while removing from active queries |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "4",
"clientId": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"status": "ACTIVE",
"email": "abc123",
"phone": "abc123",
"current": 123,
"thirtyDays": 123,
"sixtyDays": 987,
"ninetyDays": 987,
"totalDue": 123,
"lastPaymentDate": datetime,
"lastStatementDate": datetime,
"lastReminderSentAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
AccountsReceivableSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AccountsReceivableSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AccountsReceivableSchemaEdge]
}
AccountsReceivableSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - AccountsReceivableSchema!
|
|
cursor - String!
|
Example
{
"node": AccountsReceivableSchema,
"cursor": "xyz789"
}
AccountsReceivableTotalsSchema
Fields
| Field Name | Description |
|---|---|
totalCurrent - Int
|
Sum of all current balances (0-29 days) across all accounts (stored as integer cents). Aggregated from AccountsReceivable.current field. Used for clinic-wide accounts receivable reporting |
totalThirtyDays - Int
|
Sum of all 30-59 day balances across all accounts (stored as integer cents). Aggregated from AccountsReceivable.thirty_days field. Used for clinic-wide accounts receivable reporting |
totalSixtyDays - Int
|
Sum of all 60-89 day balances across all accounts (stored as integer cents). Aggregated from AccountsReceivable.sixty_days field. Used for clinic-wide accounts receivable reporting |
totalNinetyDays - Int
|
Sum of all 90+ day balances across all accounts (stored as integer cents). Aggregated from AccountsReceivable.ninety_days field. Used for clinic-wide accounts receivable reporting |
totalDue - Int
|
Sum of all outstanding balances across all accounts (stored as integer cents). Aggregated from AccountsReceivable.total_due field. Represents the total amount owed to the clinic |
lastSyncedAt - datetime
|
Timestamp of when the accounts receivable data was last synchronized. Updated by sync_accounts_receivable() and stored in Settings model. Used to track data freshness and determine when next sync is needed |
Example
{
"totalCurrent": 987,
"totalThirtyDays": 987,
"totalSixtyDays": 987,
"totalNinetyDays": 987,
"totalDue": 987,
"lastSyncedAt": datetime
}
AccountsReceivableViewFilterSchema
Fields
| Input Field | Description |
|---|---|
clientId - StrFilter
|
|
firstName - StrFilter
|
|
lastName - StrFilter
|
|
status - StrFilter
|
|
email - StrFilter
|
|
phone - StrFilter
|
|
current - IntFilter
|
|
thirtyDays - IntFilter
|
|
sixtyDays - IntFilter
|
|
ninetyDays - IntFilter
|
|
totalDue - IntFilter
|
|
lastPaymentDate - DateFilter
|
|
lastStatementDate - DateFilter
|
|
lastReminderSentAt - DateFilter
|
Example
{
"clientId": StrFilter,
"firstName": StrFilter,
"lastName": StrFilter,
"status": StrFilter,
"email": StrFilter,
"phone": StrFilter,
"current": IntFilter,
"thirtyDays": IntFilter,
"sixtyDays": IntFilter,
"ninetyDays": IntFilter,
"totalDue": IntFilter,
"lastPaymentDate": DateFilter,
"lastStatementDate": DateFilter,
"lastReminderSentAt": DateFilter
}
AchDebitSchema
ActionTiming
Fields
| Field Name | Description |
|---|---|
type - TimingType!
|
|
value - Int
|
|
unit - String
|
|
when - String
|
Example
{
"type": "IMMEDIATE",
"value": 987,
"unit": "abc123",
"when": "abc123"
}
ActionTimingInput
Fields
| Input Field | Description |
|---|---|
type - TimingType!
|
|
value - Int
|
|
unit - String
|
|
when - String
|
Example
{
"type": "IMMEDIATE",
"value": 123,
"unit": "xyz789",
"when": "xyz789"
}
ActionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SEND_EMAIL"
AddendumCreateSchema
Fields
| Input Field | Description |
|---|---|
refId - ID!
|
Reference to the parent document (SOAP, Surgery, VisitNote, or OrderNote). Required field that links this addendum to its parent note. When created, the addendum ID is automatically appended to the parent's addendum_ids array |
refType - AddendumRefTypeEnum!
|
Type of parent document this addendum is attached to. Must be one of: SOAP, SURGERY, VISIT_NOTE, or ORDER_NOTE. Determines which service method is called to attach the addendum to its parent |
creatorId - ID!
|
User who created this addendum (ClinicUser). Required field used to track authorship and display creator information |
description - String!
|
The actual addendum content/text. Required field containing the supplementary information being added to the parent note |
timestamp - datetime!
|
When the addendum was created (distinct from created_at). Required field that represents the clinical timestamp of when the addendum was made. Typically set to the current time when the addendum is created |
Example
{
"refId": "4",
"refType": "SOAP",
"creatorId": 4,
"description": "xyz789",
"timestamp": datetime
}
AddendumRefTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SOAP"
AddendumSchema
Fields
| Field Name | Description |
|---|---|
creator - ClinicUserSchema
|
|
id - ID!
|
MongoDB document ObjectID |
refId - ID!
|
Reference to the parent document (SOAP, Surgery, VisitNote, or OrderNote). Required field that links this addendum to its parent note. When created, the addendum ID is automatically appended to the parent's addendum_ids array |
refType - AddendumRefTypeEnum!
|
Type of parent document this addendum is attached to. Must be one of: SOAP, SURGERY, VISIT_NOTE, or ORDER_NOTE. Determines which service method is called to attach the addendum to its parent |
creatorId - ID!
|
User who created this addendum (ClinicUser). Required field used to track authorship and display creator information |
description - String!
|
The actual addendum content/text. Required field containing the supplementary information being added to the parent note |
timestamp - datetime!
|
When the addendum was created (distinct from created_at). Required field that represents the clinical timestamp of when the addendum was made. Typically set to the current time when the addendum is created |
deletedAt - datetime
|
Soft deletion timestamp. When set, indicates the addendum has been deleted but is retained for audit purposes. Deleted addendums are excluded from normal queries |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"creator": ClinicUserSchema,
"id": 4,
"refId": 4,
"refType": "SOAP",
"creatorId": 4,
"description": "abc123",
"timestamp": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
AddendumUpdateSchema
AddendumViewFilterSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
AddendumViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
MongoDB document ID exposed as 'id' field via pipeline transformation |
refId - String!
|
Reference to the parent document (SOAP, Surgery, VisitNote, or OrderNote). Required field that links this addendum to its parent note |
refType - AddendumRefTypeEnum!
|
Type of parent document this addendum is attached to. String representation of AddendumRefTypeEnum values |
creatorId - String!
|
User who created this addendum (ClinicUser). The pipeline performs a lookup to join creator information from clinic_user collection |
description - String!
|
The actual addendum content/text. Required field containing the supplementary information being added to the parent note |
timestamp - datetime!
|
When the addendum was created (distinct from created_at). Required field that represents the clinical timestamp of when the addendum was made |
deletedAt - datetime
|
Soft deletion timestamp. When set, indicates the addendum has been deleted but is retained for audit purposes |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "abc123",
"refId": "xyz789",
"refType": "SOAP",
"creatorId": "abc123",
"description": "abc123",
"timestamp": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
AddendumViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AddendumViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AddendumViewSchemaEdge]
}
AddendumViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - AddendumViewSchema!
|
|
cursor - String!
|
Example
{
"node": AddendumViewSchema,
"cursor": "xyz789"
}
AppointmentCheckoutSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
appointmentId - ID!
|
Reference to the appointment (Appointment model) this checkout is for. Required field - checkout cannot exist without an appointment. One-to-one relationship: each appointment has at most one checkout |
soapId - ID
|
Reference to the medical record (Soap model) associated with this checkout. Populated from appointment.soap_id when checkout is created |
surgeryId - ID
|
Reference to the surgery record (Surgery model) associated with this checkout. Populated from appointment.surgery_id when checkout is created |
deletedAt - datetime
|
Soft delete timestamp - checkout still exists in DB but is considered deleted. Used to preserve historical data while removing from active queries |
todos - [EmailOrPrintTodoSchemaRxScriptTodoSchemaVaccineCertificateTodoSchemaLabTodoSchemaScheduleFollowUpTodoSchemaPaymentTodoSchema!]!
|
List of tasks to complete before finalizing the appointment. Automatically populated based on treatments, labs, and follow-ups in soap/surgery. Uses discriminated union pattern with todo_type field for polymorphic behavior |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "4",
"appointmentId": "4",
"soapId": "4",
"surgeryId": "4",
"deletedAt": datetime,
"todos": [EmailOrPrintTodoSchema],
"createdAt": datetime,
"updatedAt": datetime
}
AppointmentCheckoutUpdateSchema
AppointmentCheckoutViewFilterSchema
Fields
| Input Field | Description |
|---|---|
appointmentId - ListObjectIdFilter
|
|
soapId - ListObjectIdFilter
|
|
surgeryId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"appointmentId": ListObjectIdFilter,
"soapId": ListObjectIdFilter,
"surgeryId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
AppointmentCheckoutViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
appointmentId - ID!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
deletedAt - datetime
|
|
todos - [TodoSchema!]!
|
|
appointment - AppointmentSchema!
|
Populated appointment object from the appointments collection via MongoDB aggregation pipeline. Always populated in the view (required field) |
soap - SoapSchema
|
Populated soap object from the soaps collection when soap_id exists. Contains the full medical record details for this checkout |
surgery - SurgerySchema
|
Populated surgery object from the surgeries collection when surgery_id exists. Contains the full surgery record details for this checkout |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "xyz789",
"appointmentId": 4,
"soapId": "4",
"surgeryId": "4",
"deletedAt": datetime,
"todos": [TodoSchema],
"appointment": AppointmentSchema,
"soap": SoapSchema,
"surgery": SurgerySchema,
"createdAt": datetime,
"updatedAt": datetime
}
AppointmentCheckoutViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AppointmentCheckoutViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AppointmentCheckoutViewSchemaEdge]
}
AppointmentCheckoutViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - AppointmentCheckoutViewSchema!
|
|
cursor - String!
|
Example
{
"node": AppointmentCheckoutViewSchema,
"cursor": "abc123"
}
AppointmentCreateSchema
Fields
| Input Field | Description |
|---|---|
creatorUid - ID!
|
|
startDatetime - datetime!
|
|
endDatetime - datetime!
|
|
assignedUid - ID
|
|
patientId - ID
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
clientId - ID
|
|
appointmentTypeId - ID
|
|
status - AppointmentStatus
|
|
staffNotes - String
|
|
checkinTime - datetime
|
|
reminderNotifSent - Boolean
|
|
confirmNotifSent - Boolean
|
|
smsReminderNotifId - ID
|
|
isOnlineRequest - Boolean
|
|
followUpNotes - String
|
|
alternativeTimes - String
|
|
freq - FrequencyEnum
|
|
interval - Int
|
|
numRepeats - Int
|
Example
{
"creatorUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"assignedUid": "4",
"patientId": "4",
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"clientId": 4,
"appointmentTypeId": "4",
"status": "TEMPORARY_BLOCK",
"staffNotes": "abc123",
"checkinTime": datetime,
"reminderNotifSent": false,
"confirmNotifSent": false,
"smsReminderNotifId": "4",
"isOnlineRequest": true,
"followUpNotes": "abc123",
"alternativeTimes": "xyz789",
"freq": "WEEKLY",
"interval": 987,
"numRepeats": 123
}
AppointmentSchema
Fields
| Field Name | Description |
|---|---|
appointmentId - ID!
|
|
assignedUid - ID!
|
|
creatorUid - ID!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
assignedEmployee - ClinicUserSchema
|
|
patientId - ID
|
|
patient - PatientSchema
|
|
clientId - ID
|
|
client - ClinicUserSchema
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
appointmentTypeId - ID
|
|
status - AppointmentStatus!
|
|
startDatetime - datetime
|
|
endDatetime - datetime
|
|
checkinTime - datetime
|
|
staffNotes - String
|
|
reminderNotifSent - Boolean!
|
|
confirmNotifSent - Boolean!
|
|
isRecurring - Boolean
|
|
smsReminderNotifId - ID
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
isOnlineRequest - Boolean!
|
|
followUpNotes - String
|
|
alternativeTimes - String
|
|
onlineRequestExpireAt - datetime
|
|
cancellationReason - String
|
|
lastAppointment - BaseAppointmentSchema
|
|
isEmailable - Boolean!
|
|
isSmsable - Boolean!
|
|
convertToLocal - Boolean!
|
|
Arguments
|
|
Example
{
"appointmentId": "4",
"assignedUid": 4,
"creatorUid": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"assignedEmployee": ClinicUserSchema,
"patientId": 4,
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": "4",
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": true,
"isRecurring": false,
"smsReminderNotifId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": false,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"lastAppointment": BaseAppointmentSchema,
"isEmailable": true,
"isSmsable": true,
"convertToLocal": true
}
AppointmentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TEMPORARY_BLOCK"
AppointmentTypeCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MEDICAL"
AppointmentTypeCreateSchema
Example
{
"creatorId": 4,
"name": "abc123",
"category": "abc123",
"description": "xyz789",
"color": "abc123",
"defaultMinutes": 123,
"depositAmount": 123,
"order": 123,
"directOnlineEnabled": true,
"sendReminderNotifications": true
}
AppointmentTypeOrderSchema
Fields
| Input Field | Description |
|---|---|
appointmentTypeIds - [ID!]!
|
Example
{"appointmentTypeIds": ["4"]}
AppointmentTypeResolveSchema
AppointmentTypeSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
creatorId - ID
|
User who created this appointment type (references ClinicUser). Used for tracking which staff member configured appointment types |
legacyKey - String
|
Unique identifier from legacy system migrations. Maintained for backward compatibility with imported data |
name - String!
|
Display name of the appointment type shown in UI and scheduling. Required field - must be provided when creating appointment types. Examples: 'Wellness Exam', 'Surgery Consultation', 'Dental Cleaning' |
category - AppointmentTypeCategory
|
Categorizes appointment as either patient care (MEDICAL) or internal scheduling (GENERAL). MEDICAL: For patient appointments that involve medical services. GENERAL: For lunch breaks, meetings, administrative time blocks. Affects validation - GENERAL appointments don't require patient_id (Appointment model) |
description - String
|
Additional details about this appointment type shown to staff/clients. Can include preparation instructions or service descriptions |
color - String!
|
Hex color code for visual identification in calendar/scheduling views. Format: '#RRGGBB' - used for appointment display in UI |
defaultMinutes - Int
|
Standard duration in minutes for appointments of this type. Used as default when creating new appointments. Can be overridden per appointment instance |
depositRequired - Boolean
|
Whether this appointment type requires a deposit payment. When true, appointment creation will require a transaction |
depositAmount - Int
|
Deposit amount in cents (integer currency representation). Only enforced when deposit_required is True. Example: 5000 = $50.00 USD. Validated against transaction amount during appointment booking (appointments service) |
order - Int
|
Display order for sorting appointment types in UI lists. Lower numbers appear first, null values appear last. Can be reordered via reorder_appointment_types service method |
directOnlineEnabled - Boolean
|
Whether this appointment type can be booked through online scheduling. Controls visibility in public-facing appointment request forms. Set to False during soft delete to prevent new bookings |
isRequired - Boolean
|
System-required appointment type that cannot be deleted. Prevents accidental removal of critical appointment types. Deletion attempts will raise validation error (appointment_types service) |
sendReminderNotifications - Boolean
|
Whether to send automated reminder notifications for this appointment type. Controls SMS/email reminders sent before appointment time |
deletedAt - datetime
|
Soft delete timestamp - appointment types are not physically deleted. When set, appointment type is hidden from active lists. direct_online_enabled is set to False during deletion |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"creatorId": "4",
"legacyKey": "xyz789",
"name": "abc123",
"category": "MEDICAL",
"description": "xyz789",
"color": "xyz789",
"defaultMinutes": 987,
"depositRequired": false,
"depositAmount": 123,
"order": 123,
"directOnlineEnabled": false,
"isRequired": true,
"sendReminderNotifications": true,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
AppointmentTypeUpdateSchema
Example
{
"id": "4",
"creatorId": "4",
"name": "abc123",
"category": "abc123",
"description": "abc123",
"color": "xyz789",
"defaultMinutes": 987,
"depositAmount": 987,
"order": 123,
"directOnlineEnabled": true,
"sendReminderNotifications": false
}
AppointmentTypeViewFilterSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
AppointmentTypeViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
legacyKey - String
|
|
creator - ClinicUserSchema
|
|
name - String!
|
|
description - String
|
|
category - AppointmentTypeCategory
|
|
color - String
|
|
defaultMinutes - Int
|
|
depositRequired - Boolean
|
|
depositAmount - Int
|
|
order - Int
|
|
directOnlineEnabled - Boolean
|
|
sendReminderNotifications - Boolean
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "xyz789",
"legacyKey": "abc123",
"creator": ClinicUserSchema,
"name": "abc123",
"description": "abc123",
"category": "MEDICAL",
"color": "abc123",
"defaultMinutes": 987,
"depositRequired": true,
"depositAmount": 123,
"order": 987,
"directOnlineEnabled": false,
"sendReminderNotifications": true,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
AppointmentTypeViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AppointmentTypeViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AppointmentTypeViewSchemaEdge]
}
AppointmentTypeViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - AppointmentTypeViewSchema!
|
|
cursor - String!
|
Example
{
"node": AppointmentTypeViewSchema,
"cursor": "xyz789"
}
AppointmentUpdateSchema
Fields
| Input Field | Description |
|---|---|
appointmentId - ID!
|
|
creatorUid - ID
|
|
assignedUid - ID
|
|
patientId - ID
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
clientId - ID
|
|
appointmentTypeId - ID
|
|
status - AppointmentStatus
|
|
startDatetime - datetime
|
|
endDatetime - datetime
|
|
reminderNotifSent - Boolean
|
|
confirmNotifSent - Boolean
|
|
smsReminderNotifId - ID
|
|
staffNotes - String
|
|
isOnlineRequest - Boolean
|
|
followUpNotes - String
|
|
alternativeTimes - String
|
|
onlineRequestExpireAt - datetime
|
|
cancellationReason - String
|
|
updateRecurringMode - UpdateRecurringMode
|
|
startAndEnd - OfficeHourEntryUpdateSchema
|
Example
{
"appointmentId": 4,
"creatorUid": 4,
"assignedUid": 4,
"patientId": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"clientId": "4",
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"reminderNotifSent": false,
"confirmNotifSent": false,
"smsReminderNotifId": "4",
"staffNotes": "xyz789",
"isOnlineRequest": true,
"followUpNotes": "abc123",
"alternativeTimes": "abc123",
"onlineRequestExpireAt": datetime,
"cancellationReason": "xyz789",
"updateRecurringMode": "THIS_EVENT_ONLY",
"startAndEnd": OfficeHourEntryUpdateSchema
}
AppointmentViewFilterSchema
Fields
| Input Field | Description |
|---|---|
startDatetime - DateFilter
|
|
endDatetime - DateFilter
|
|
status - StrFilter
|
|
patientId - ListObjectIdFilter
|
|
clientId - ListObjectIdFilter
|
|
assignedUid - ListObjectIdFilter
|
|
appointmentTypeId - ListObjectIdFilter
|
|
staffNotes - StrFilter
|
|
appointmentPending - BoolFilter
|
|
notAppointmentPending - BoolFilter
|
|
deletedAt - StrFilter
|
Example
{
"startDatetime": DateFilter,
"endDatetime": DateFilter,
"status": StrFilter,
"patientId": ListObjectIdFilter,
"clientId": ListObjectIdFilter,
"assignedUid": ListObjectIdFilter,
"appointmentTypeId": ListObjectIdFilter,
"staffNotes": StrFilter,
"appointmentPending": BoolFilter,
"notAppointmentPending": BoolFilter,
"deletedAt": StrFilter
}
AppointmentViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
appointmentId - ID!
|
|
creatorUid - ID!
|
|
assignedUid - ID
|
|
patientId - ID
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
status - String!
|
|
startDatetime - datetime!
|
|
endDatetime - datetime!
|
|
fullDay - Boolean!
|
|
checkinTime - datetime
|
|
staffNotes - String
|
|
reminderNotifSent - Boolean!
|
|
confirmNotifSent - Boolean!
|
|
smsReminderNotifId - ID
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
assignedEmployee - ClinicUserSchema
|
|
patient - PatientSchema
|
|
client - ClinicUserSchema
|
|
appointmentTypeId - ID
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
isOnlineRequest - Boolean!
|
|
followUpNotes - String
|
|
alternativeTimes - String
|
|
onlineRequestExpireAt - datetime
|
|
cancellationReason - String
|
|
isRecurring - Boolean
|
Example
{
"id": "4",
"appointmentId": 4,
"creatorUid": "4",
"assignedUid": "4",
"patientId": "4",
"soapId": 4,
"surgeryId": "4",
"visitNoteId": 4,
"status": "xyz789",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": false,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"assignedEmployee": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"appointmentTypeId": "4",
"appointmentType": AppointmentTypeResolveSchema,
"isOnlineRequest": false,
"followUpNotes": "xyz789",
"alternativeTimes": "xyz789",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123",
"isRecurring": true
}
AppointmentViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AppointmentViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AppointmentViewSchemaEdge]
}
AppointmentViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - AppointmentViewSchema!
|
|
cursor - String!
|
Example
{
"node": AppointmentViewSchema,
"cursor": "abc123"
}
ApprovalMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIGITAL_SIGNATURE"
AskCoCoConfigInput
Fields
| Input Field | Description |
|---|---|
searchKwargs - SearchKwargsInput!
|
|
sessionId - String
|
Example
{
"searchKwargs": SearchKwargsInput,
"sessionId": "abc123"
}
AskCoCoInputData
Fields
| Input Field | Description |
|---|---|
ability - String!
|
|
question - String!
|
|
patientName - String!
|
|
patientInfo - AskCoCoPatientInfoInput!
|
Example
{
"ability": "abc123",
"question": "abc123",
"patientName": "abc123",
"patientInfo": AskCoCoPatientInfoInput
}
AskCoCoPatientInfoInput
Fields
| Input Field | Description |
|---|---|
breed - String
|
|
color - String
|
|
age - String
|
|
gender - String
|
|
hasActiveCheckout - Boolean
|
|
microchip - String
|
|
species - String
|
|
status - String
|
|
warnings - String
|
|
dateOfBirth - String
|
|
dateOfDeath - String
|
|
weightLbs - String
|
|
weightKg - String
|
|
strerilization - String
|
|
genderSterilization - String
|
|
firstName - String
|
|
lastName - String
|
Example
{
"breed": "abc123",
"color": "abc123",
"age": "abc123",
"gender": "abc123",
"hasActiveCheckout": false,
"microchip": "xyz789",
"species": "xyz789",
"status": "xyz789",
"warnings": "xyz789",
"dateOfBirth": "abc123",
"dateOfDeath": "abc123",
"weightLbs": "abc123",
"weightKg": "abc123",
"strerilization": "xyz789",
"genderSterilization": "xyz789",
"firstName": "xyz789",
"lastName": "abc123"
}
AskCoCoRequest
Fields
| Input Field | Description |
|---|---|
input - AskCoCoInputData!
|
|
config - AskCoCoConfigInput!
|
Example
{
"input": AskCoCoInputData,
"config": AskCoCoConfigInput
}
AskCoCoResponse
Fields
| Field Name | Description |
|---|---|
content - String!
|
|
docs - [MedicalHistoryViewSchema!]!
|
Example
{
"content": "abc123",
"docs": [MedicalHistoryViewSchema]
}
AudioMediaFilterSchema
Fields
| Input Field | Description |
|---|---|
resourceType - ResourceTypes
|
|
status - MediaStatus
|
Example
{"resourceType": "CLINIC_USER", "status": "PENDING"}
AuditFilterSchema
Fields
| Input Field | Description |
|---|---|
objectType - StrFilter
|
|
objectId - ObjectIdFilter
|
|
createdAt - DateFilter
|
Example
{
"objectType": StrFilter,
"objectId": ObjectIdFilter,
"createdAt": DateFilter
}
AuditSchema
Fields
| Field Name | Description |
|---|---|
creatorId - ID
|
|
id - ID!
|
MongoDB document ObjectID |
changes - JSON!
|
The calculated differences between the original object state and the new state. Generated using DeepDiff library to identify value changes, type changes, additions, and deletions. Excludes created_at and updated_at fields from comparison. Type changes are converted to string representation for JSON serialization |
snapshot - JSON!
|
Complete JSON snapshot of the object's state after the change. Captures the full object data for historical reference and rollback capabilities. Generated using the object's to_json() method |
objectType - String!
|
The collection name of the audited object (e.g., 'patients', 'appointments', 'users'). Corresponds to the Settings.name property of the audited Document model. Used for filtering audit logs by entity type |
objectId - ID!
|
The MongoDB ObjectId of the audited object. Links this audit record to the specific document that was modified. Indexed for efficient querying of audit history for specific objects |
creatorMeta - JSON
|
Additional metadata about the user who made the change (optional). Contains user details like first_name, last_name, email for audit trail purposes. May include admin_id field when change is made by an admin user. Structure: {'id': str, 'first_name': str, 'last_name': str, 'email': str, 'admin_id': str (optional)} |
createdAt - datetime!
|
Example
{
"creatorId": "4",
"id": "4",
"changes": {},
"snapshot": {},
"objectType": "abc123",
"objectId": "4",
"creatorMeta": {},
"createdAt": datetime
}
AuditSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AuditSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AuditSchemaEdge]
}
AuditSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - AuditSchema!
|
|
cursor - String!
|
Example
{
"node": AuditSchema,
"cursor": "abc123"
}
BankAccountSchema
Example
{
"defaultForCurrency": true,
"updatedAt": "xyz789",
"createdAt": "xyz789",
"id": "xyz789",
"routingNumber": "abc123",
"accountId": "xyz789",
"last4": "xyz789",
"accountHolderName": "abc123",
"bankName": "xyz789",
"type": "abc123",
"currency": "abc123",
"status": "abc123"
}
BaseAppointmentSchema
Fields
| Field Name | Description |
|---|---|
appointmentId - ID!
|
|
assignedUid - ID!
|
|
creatorUid - ID!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
assignedEmployee - ClinicUserSchema
|
|
patientId - ID
|
|
patient - PatientSchema
|
|
clientId - ID
|
|
client - ClinicUserSchema
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
appointmentTypeId - ID
|
|
status - AppointmentStatus!
|
|
startDatetime - datetime
|
|
endDatetime - datetime
|
|
checkinTime - datetime
|
|
staffNotes - String
|
|
reminderNotifSent - Boolean!
|
|
confirmNotifSent - Boolean!
|
|
isRecurring - Boolean
|
|
smsReminderNotifId - ID
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
isOnlineRequest - Boolean!
|
|
followUpNotes - String
|
|
alternativeTimes - String
|
|
onlineRequestExpireAt - datetime
|
|
cancellationReason - String
|
Example
{
"appointmentId": 4,
"assignedUid": 4,
"creatorUid": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"assignedEmployee": ClinicUserSchema,
"patientId": "4",
"patient": PatientSchema,
"clientId": "4",
"client": ClinicUserSchema,
"appointmentType": AppointmentTypeResolveSchema,
"appointmentTypeId": 4,
"status": "TEMPORARY_BLOCK",
"startDatetime": datetime,
"endDatetime": datetime,
"checkinTime": datetime,
"staffNotes": "abc123",
"reminderNotifSent": true,
"confirmNotifSent": false,
"isRecurring": true,
"smsReminderNotifId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"isOnlineRequest": true,
"followUpNotes": "xyz789",
"alternativeTimes": "xyz789",
"onlineRequestExpireAt": datetime,
"cancellationReason": "abc123"
}
BatchScheduleUpdateSchema
Fields
| Input Field | Description |
|---|---|
schedules - [ScheduleChangeSchema!]!
|
Example
{"schedules": [ScheduleChangeSchema]}
BillingDetailsAddressSchema
BillingDetailsSchema
Fields
| Field Name | Description |
|---|---|
address - BillingDetailsAddressSchema
|
|
email - String
|
|
name - String
|
|
phone - String
|
Example
{
"address": BillingDetailsAddressSchema,
"email": "xyz789",
"name": "xyz789",
"phone": "abc123"
}
BoardingReservationCreateSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ID!
|
Reference to the clinic staff member who created this reservation (ClinicUser). Required field used for tracking reservation ownership and access control |
patientId - ID!
|
Reference to the patient being boarded (ClinicPatient). Required field that links the reservation to the specific animal |
kennelId - ID!
|
Reference to the kennel assigned for this reservation (Kennel). Required field that determines the physical location for boarding. Used in queries to check kennel availability and conflicts |
startDatetime - datetime!
|
Start date and time for the boarding period. Required field that marks the beginning of the reservation. Used in date range queries to find overlapping reservations |
endDatetime - datetime!
|
End date and time for the boarding period. Required field that marks the end of the reservation. Used with start_datetime to determine reservation duration and conflicts |
notes - String
|
Additional notes or special instructions for the boarding reservation. Optional in GraphQL creation schema but typed as required in model. Stores important care instructions, dietary requirements, or behavioral notes |
Example
{
"creatorId": 4,
"patientId": 4,
"kennelId": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789"
}
BoardingReservationSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
creatorId - ID!
|
Reference to the clinic staff member who created this reservation (ClinicUser). Required field used for tracking reservation ownership and access control |
patientId - ID!
|
Reference to the patient being boarded (ClinicPatient). Required field that links the reservation to the specific animal |
kennelId - ID!
|
Reference to the kennel assigned for this reservation (Kennel). Required field that determines the physical location for boarding. Used in queries to check kennel availability and conflicts |
startDatetime - datetime!
|
Start date and time for the boarding period. Required field that marks the beginning of the reservation. Used in date range queries to find overlapping reservations |
endDatetime - datetime!
|
End date and time for the boarding period. Required field that marks the end of the reservation. Used with start_datetime to determine reservation duration and conflicts |
notes - String!
|
Additional notes or special instructions for the boarding reservation. Optional in GraphQL creation schema but typed as required in model. Stores important care instructions, dietary requirements, or behavioral notes |
status - BoardingReservationStatus!
|
Current status of the boarding reservation. Defaults to BOOKED when created, progresses through workflow states. CANCELED status reservations are filtered out of most queries |
deletedAt - datetime
|
Soft deletion timestamp - when set, reservation is considered deleted. Used instead of hard deletion to maintain data integrity and audit trails. Set automatically when reservation is canceled via cancel_boarding_reservation mutation |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "4",
"creatorId": 4,
"patientId": "4",
"kennelId": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
BoardingReservationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_CONFIRMED"
BoardingReservationUpdateSchema
Example
{
"id": "4",
"creatorId": 4,
"patientId": 4,
"kennelId": 4,
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "xyz789",
"status": "NOT_CONFIRMED"
}
BoardingReservationViewFilterSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
BoardingReservationViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
kennelId - ID!
|
|
creator - ClinicUserSchema!
|
|
patient - PatientSchema!
|
|
client - ClinicUserSchema!
|
|
kennel - KennelSchema!
|
|
startDatetime - datetime!
|
|
endDatetime - datetime!
|
|
notes - String!
|
|
status - BoardingReservationStatus!
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "abc123",
"kennelId": 4,
"creator": ClinicUserSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"kennel": KennelSchema,
"startDatetime": datetime,
"endDatetime": datetime,
"notes": "abc123",
"status": "NOT_CONFIRMED",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
BoardingReservationViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [BoardingReservationViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [BoardingReservationViewSchemaEdge]
}
BoardingReservationViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - BoardingReservationViewSchema!
|
|
cursor - String!
|
Example
{
"node": BoardingReservationViewSchema,
"cursor": "abc123"
}
BoolFilter
Fields
| Input Field | Description |
|---|---|
value1 - Boolean!
|
|
operator - ComparisonOperators!
|
|
value2 - Boolean
|
Example
{"value1": false, "operator": "EQ", "value2": false}
Boolean
Description
The Boolean scalar type represents true or false.
BreedInputSchema
BreedSchema
BundleCreateSchema
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
treatments - [BundleTreatmentCreateSchema!]!
|
|
useQtyRange - Boolean
|
|
hideAllItemsPrices - Boolean
|
Example
{
"name": "abc123",
"treatments": [BundleTreatmentCreateSchema],
"useQtyRange": false,
"hideAllItemsPrices": false
}
BundleOptionsInput
Fields
| Input Field | Description |
|---|---|
useItemsMaxQty - Boolean!
|
Example
{"useItemsMaxQty": false}
BundleSchema
Fields
| Field Name | Description |
|---|---|
bundleId - ID!
|
Unique identifier for the bundle, automatically set to MongoDB's _id after creation. Used for external API references and relationships with other models. Initially None, gets populated in create_bundle() and update_bundle() methods |
name - String!
|
Display name for the bundle, required field for identification purposes. Used in UI components and reporting to identify the bundle |
treatments - [BundleTreatmentSchema!]!
|
List of Treatment objects that are part of this bundle. Treatments are automatically updated when the underlying Treatment model changes (app.services.bundles.update_bundles_with_treatment). If a Treatment is deleted (deleted_at is set), it's automatically removed from all bundles. Embedded as full Treatment documents rather than references to maintain data consistency |
createdAt - datetime
|
|
updatedAt - datetime
|
|
useQtyRange - Boolean
|
Indicates if the bundle should display quantity range for treatments in the UI. If True, shows min-max quantities |
hideAllItemsPrices - Boolean
|
Whether to hide the prices of all items in the bundle in estimates and invoices |
Example
{
"bundleId": "4",
"name": "abc123",
"treatments": [BundleTreatmentSchema],
"createdAt": datetime,
"updatedAt": datetime,
"useQtyRange": true,
"hideAllItemsPrices": true
}
BundleSearchResultSchema
Fields
| Field Name | Description |
|---|---|
node - BundleSchema!
|
|
highlights - [HighlightSchema!]
|
|
score - Float
|
Example
{
"node": BundleSchema,
"highlights": [HighlightSchema],
"score": 987.65
}
BundleTreatmentCreateSchema
Example
{
"treatmentId": 4,
"name": "xyz789",
"minimumQty": Decimal,
"maximumQty": Decimal,
"pricePerUnit": 987,
"order": 123,
"hideItem": true
}
BundleTreatmentSchema
Fields
| Field Name | Description |
|---|---|
name - String!
|
Name of the treatment included in the bundle |
treatmentId - ID!
|
Reference to the Treatment model included in the bundle |
pricePerUnit - Int!
|
Price per unit for this treatment when included in the bundle |
minimumQty - Decimal!
|
Minimum quantity of this treatment allowed in the bundle |
maximumQty - Decimal
|
Maximum quantity of this treatment allowed in the bundle |
order - Int
|
Order of the treatment in the bundle for display purposes |
hideItem - Boolean
|
Whether to hide the item from the bundle in estimates and invoices |
Example
{
"name": "abc123",
"treatmentId": "4",
"pricePerUnit": 987,
"minimumQty": Decimal,
"maximumQty": Decimal,
"order": 987,
"hideItem": true
}
BundleUpdateSchema
Fields
| Input Field | Description |
|---|---|
bundleId - ID!
|
|
name - String!
|
|
treatments - [BundleTreatmentCreateSchema!]!
|
|
useQtyRange - Boolean
|
|
hideAllItemsPrices - Boolean
|
Example
{
"bundleId": "4",
"name": "abc123",
"treatments": [BundleTreatmentCreateSchema],
"useQtyRange": true,
"hideAllItemsPrices": true
}
CalendarOptionsSchema
Example
{
"stepInt": 987,
"allowApptDrag": true,
"allowScheduleOver": true,
"allowExperimental": true,
"bypassRequiredCheckinFields": true,
"hideCancelled": true
}
CalendarOptionsUpdateSchema
Example
{
"stepInt": 123,
"allowApptDrag": false,
"allowScheduleOver": true,
"allowExperimental": true,
"bypassRequiredCheckinFields": true,
"hideCancelled": true
}
CallDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INTERNAL"
CallSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
sourceNumber - String
|
|
sourceClient - ClinicUserSchema
|
|
destinationClient - ClinicUserSchema
|
|
analytics - CallSummaryAnalyticsSchema
|
|
callUrl - String
|
|
mangoWebhookRequestId - ID
|
|
isRecorded - String
|
|
callDirection - CallDirection!
|
|
callStatus - CallStatus!
|
|
callTime - datetime!
|
|
callUuid - String
|
|
destinationNumber - String
|
|
dstExt - String
|
|
mangoSourceNumber - String
|
|
srcExt - String
|
|
callflow - String
|
|
conferenceId - String
|
|
duration - Int!
|
Example
{
"id": "4",
"sourceNumber": "xyz789",
"sourceClient": ClinicUserSchema,
"destinationClient": ClinicUserSchema,
"analytics": CallSummaryAnalyticsSchema,
"callUrl": "xyz789",
"mangoWebhookRequestId": "4",
"isRecorded": "xyz789",
"callDirection": "INTERNAL",
"callStatus": "ANSWERED",
"callTime": datetime,
"callUuid": "abc123",
"destinationNumber": "abc123",
"dstExt": "abc123",
"mangoSourceNumber": "xyz789",
"srcExt": "abc123",
"callflow": "abc123",
"conferenceId": "abc123",
"duration": 123
}
CallStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANSWERED"
CallSummaryAnalyticsSchema
Example
{
"summary": "xyz789",
"sentiment": {},
"transcript": "xyz789"
}
CancelPaymentsAndVoidInvoiceSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
Example
{"invoiceId": 4}
CancelReceivingPurchaseOrderItemSchema
CancelSubscriptionInput
Fields
| Input Field | Description |
|---|---|
subscriptionId - String!
|
Example
{"subscriptionId": "xyz789"}
CaptureCardPresentSessionSchema
Fields
| Input Field | Description |
|---|---|
cardPresentSessionId - ID!
|
Example
{"cardPresentSessionId": "4"}
CardBrand
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMEX"
CardPaymentMethodSchema
CardPresentSessionSchema
Example
{
"id": "abc123",
"amount": 987,
"paymentIntentId": "xyz789",
"paymentMethodId": "abc123",
"terminalId": "xyz789",
"paymentIntentStatus": "CANCELED",
"createdAt": datetime,
"updatedAt": datetime
}
CardSchema
Example
{
"brand": "AMEX",
"expMonth": 987,
"expYear": 987,
"holderName": "xyz789",
"last4": "xyz789",
"funding": "abc123",
"checks": ChecksSchema
}
CategoryTotalsSchema
Fields
| Field Name | Description |
|---|---|
totalsInventoryByAahaCategories - [TransactionsReportAAHACategories!]!
|
|
totalsShrinkageByAahaCategories - [TransactionsReportAAHACategories!]!
|
Example
{
"totalsInventoryByAahaCategories": [
TransactionsReportAAHACategories
],
"totalsShrinkageByAahaCategories": [
TransactionsReportAAHACategories
]
}
ChartOptionsSchema
ChartOptionsUpdateSchema
ChatSessionMessageSchema
ChatSessionMessageUpdateSchema
ChatSessionSchema
Fields
| Field Name | Description |
|---|---|
chatSessionId - String!
|
Unique identifier for the AI chat session. Required field - used to track and group related chat interactions. Generated externally and passed in when creating chat sessions |
question - String!
|
The question or query submitted to the AI system. Required field - stores the actual text of the patient-related inquiry. Used for chat history and AI context building |
messages - [ChatSessionMessageSchema!]
|
The messages in the chat session. Optional field - stores the messages in the chat session. Used for chat history and AI context building |
createdAt - datetime!
|
Example
{
"chatSessionId": "abc123",
"question": "xyz789",
"messages": [ChatSessionMessageSchema],
"createdAt": datetime
}
ChatSessionUpdateSchema
Fields
| Input Field | Description |
|---|---|
chatSessionId - String!
|
Unique identifier for the AI chat session. Required field - used to track and group related chat interactions. Generated externally and passed in when creating chat sessions |
question - String!
|
The question or query submitted to the AI system. Required field - stores the actual text of the patient-related inquiry. Used for chat history and AI context building |
messages - [ChatSessionMessageUpdateSchema!]
|
The messages in the chat session. Optional field - stores the messages in the chat session. Used for chat history and AI context building. Default = [] |
createdAt - datetime!
|
Example
{
"chatSessionId": "xyz789",
"question": "abc123",
"messages": [ChatSessionMessageUpdateSchema],
"createdAt": datetime
}
CheckoutSessionSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
accountId - String!
|
|
amountTotal - Int!
|
|
createdAt - datetime!
|
|
currency - Currency!
|
|
paymentIntentId - String!
|
|
paymentMethodTypes - [PaymentMethodType!]!
|
|
status - CheckoutSessionStatus!
|
|
updatedAt - datetime!
|
|
url - String!
|
|
cancelUrl - String
|
|
customerId - String
|
|
expiresAt - datetime!
|
|
successUrl - String
|
Example
{
"id": "abc123",
"accountId": "abc123",
"amountTotal": 987,
"createdAt": datetime,
"currency": "AUD",
"paymentIntentId": "abc123",
"paymentMethodTypes": ["CARD"],
"status": "OPEN",
"updatedAt": datetime,
"url": "abc123",
"cancelUrl": "abc123",
"customerId": "abc123",
"expiresAt": datetime,
"successUrl": "abc123"
}
CheckoutSessionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
ChecksSchema
ClickToCallSchema
ClientCreateSchema
Fields
| Input Field | Description |
|---|---|
firstName - String!
|
|
lastName - String!
|
|
phoneH - String!
|
|
emailH - String
|
|
emailW - String
|
|
phoneW - String
|
|
phoneHType - PhoneType
|
|
phoneWType - PhoneType
|
|
street - String
|
|
city - String
|
|
state - String
|
|
zipCode - String
|
|
dateOfBirth - datetime
|
|
gender - UserGender
|
|
clientInfo - ClientInfoCreateSchema
|
|
smsConsent - SmsConsent
|
|
preferredCommunicationMethods - [PreferredCommunicationMethods!]
|
|
createdVia - PatientCreatedVia!
|
|
bypassClientExistenceCheck - Boolean
|
Example
{
"firstName": "abc123",
"lastName": "xyz789",
"phoneH": "abc123",
"emailH": "abc123",
"emailW": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "abc123",
"state": "xyz789",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"clientInfo": ClientInfoCreateSchema,
"smsConsent": "OPT_IN",
"preferredCommunicationMethods": ["CALL"],
"createdVia": "APP",
"bypassClientExistenceCheck": true
}
ClientInfoCreateSchema
ClientInfoSchema
Fields
| Field Name | Description |
|---|---|
clientExtId - String
|
External client identifier - can be None only during new Family creation flow. Required after family setup is complete for client identification |
familyId - ID
|
Reference to Family record containing pets and billing information. Can be None only during new Family creation, then populated automatically |
clientStatus - UserStatus
|
Client account status - defaults to ACTIVE for new clients. Used for filtering and determining service eligibility |
warnings - String
|
Special warnings or notes about this client for staff awareness. Displayed prominently in client interactions |
groupDiscountId - ID
|
Reference to GroupDiscount record for pricing adjustments. Applied automatically during invoice calculation |
taxExempt - Boolean
|
Tax exemption status for billing calculations. Prevents tax application when generating invoices |
Example
{
"clientExtId": "abc123",
"familyId": "4",
"clientStatus": "ACTIVE",
"warnings": "xyz789",
"groupDiscountId": "4",
"taxExempt": true
}
ClientInfoUpdateSchema
Fields
| Input Field | Description |
|---|---|
clientStatus - UserStatus
|
|
warnings - String
|
|
groupDiscountId - ID
|
|
taxExempt - Boolean
|
Example
{
"clientStatus": "ACTIVE",
"warnings": "xyz789",
"groupDiscountId": "4",
"taxExempt": true
}
ClientMergeInput
Example
{"sourceClientId": 4, "destinationClientId": 4, "useTransaction": false}
ClientPortalOptions
Example
{
"enabledMedicalRecords": [MedicalHistoryOptionsSchema],
"rxRefillTaskEnabled": false,
"rxRefillTaskDefaultPriority": "URGENT",
"rxRefillTaskDueDeltaInHours": 123,
"rxRefillTaskDefaultCreator": "4",
"rxRefillTaskDefaultAssignee": "4"
}
ClientPortalOptionsUpdateSchema
Example
{
"enabledMedicalRecords": [
MedicalHistoryOptionsUpdateSchema
],
"rxRefillTaskEnabled": true,
"rxRefillTaskDefaultCreator": "xyz789",
"rxRefillTaskDefaultAssignee": "abc123",
"rxRefillTaskDefaultPriority": "URGENT",
"rxRefillTaskDueDeltaInHours": 123
}
ClientQueryFilter
ClientReportNamedTotalSchema
Example
{
"name": "xyz789",
"newClientCount": 987,
"existingClientCount": 123,
"activeClientCount": 987,
"lapsingClientCount": 987,
"lapsedClientCount": 123
}
ClientReportSchema
Fields
| Field Name | Description |
|---|---|
newAndExistingClientTotals - [ClientReportNamedTotalSchema!]!
|
|
activeLapsingLapsedClientTotals - [ClientReportNamedTotalSchema!]!
|
Example
{
"newAndExistingClientTotals": [
ClientReportNamedTotalSchema
],
"activeLapsingLapsedClientTotals": [
ClientReportNamedTotalSchema
]
}
ClientSearchResultSchema
Fields
| Field Name | Description |
|---|---|
node - ClinicUserSchema!
|
|
highlights - [HighlightSchema!]
|
|
score - Float
|
Example
{
"node": ClinicUserSchema,
"highlights": [HighlightSchema],
"score": 123.45
}
ClientStatsNamedTotalSchema
ClientStatsReportItemSchema
ClientStatsReportSchema
Fields
| Field Name | Description |
|---|---|
genderTotals - [ClientStatsNamedTotalSchema!]!
|
|
ageGroupTotals - [ClientStatsNamedTotalSchema!]!
|
|
statusTotals - [ClientStatsNamedTotalSchema!]!
|
|
cityTotals - [ClientStatsNamedTotalSchema!]!
|
|
stateTotals - [ClientStatsNamedTotalSchema!]!
|
|
clientStatsReportItems - [ClientStatsReportItemSchema!]!
|
Example
{
"genderTotals": [ClientStatsNamedTotalSchema],
"ageGroupTotals": [ClientStatsNamedTotalSchema],
"statusTotals": [ClientStatsNamedTotalSchema],
"cityTotals": [ClientStatsNamedTotalSchema],
"stateTotals": [ClientStatsNamedTotalSchema],
"clientStatsReportItems": [ClientStatsReportItemSchema]
}
ClientUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
firstName - String
|
|
lastName - String
|
|
emailH - String
|
|
phoneH - String
|
|
phoneW - String
|
|
phoneHType - PhoneType
|
|
phoneWType - PhoneType
|
|
street - String
|
|
city - String
|
|
state - String
|
|
zipCode - String
|
|
dateOfBirth - datetime
|
|
gender - UserGender
|
|
clientInfo - ClientInfoUpdateSchema
|
|
profilePictureMediaId - ID
|
|
smsConsent - SmsConsent
|
|
preferredCommunicationMethods - [PreferredCommunicationMethods!]
|
|
lastReminderSentAt - datetime
|
Example
{
"id": "4",
"firstName": "abc123",
"lastName": "xyz789",
"emailH": "abc123",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "abc123",
"state": "xyz789",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"clientInfo": ClientInfoUpdateSchema,
"profilePictureMediaId": "4",
"smsConsent": "OPT_IN",
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime
}
ClinicStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
ClinicUserFilterSchema
Fields
| Input Field | Description |
|---|---|
id - ListObjectIdFilter
|
|
employeeId - ObjectIdFilter
|
|
firstName - StrFilter
|
|
emailH - StrFilter
|
|
emailW - StrFilter
|
|
phoneH - StrFilter
|
|
phoneW - StrFilter
|
|
gender - StrFilter
|
|
city - StrFilter
|
|
state - StrFilter
|
|
zipCode - StrFilter
|
|
isEmployee - StrFilter
|
|
clientStatus - StrFilter
|
|
employeeStatus - StrFilter
|
|
jobTitle - StrFilter
|
|
licenseNumber - StrFilter
|
|
smsConsent - SmsConsent
|
|
createdAt - DateFilter
|
|
updatedAt - DateFilter
|
|
firstInvoiceDate - DateFilter
|
|
lastInvoiceDate - DateFilter
|
|
clientInfoDotClientExtId - StrFilter
|
Example
{
"id": ListObjectIdFilter,
"employeeId": ObjectIdFilter,
"firstName": StrFilter,
"emailH": StrFilter,
"emailW": StrFilter,
"phoneH": StrFilter,
"phoneW": StrFilter,
"gender": StrFilter,
"city": StrFilter,
"state": StrFilter,
"zipCode": StrFilter,
"isEmployee": StrFilter,
"clientStatus": StrFilter,
"employeeStatus": StrFilter,
"jobTitle": StrFilter,
"licenseNumber": StrFilter,
"smsConsent": "OPT_IN",
"createdAt": DateFilter,
"updatedAt": DateFilter,
"firstInvoiceDate": DateFilter,
"lastInvoiceDate": DateFilter,
"clientInfoDotClientExtId": StrFilter
}
ClinicUserSchema
Fields
| Field Name | Description |
|---|---|
profilePicture - MediaSchema
|
|
id - ID!
|
|
firstName - String!
|
User's first name - required for all users |
lastName - String!
|
User's last name - required for all users |
emailH - String
|
Home email address - optional but indexed for fast lookups. Used for primary communication and authentication |
emailW - String
|
Work email address - optional and sparsely indexed |
phoneH - String!
|
Home phone number - required and indexed for fast lookups. Used as primary contact method and for duplicate user prevention |
phoneW - String
|
Work phone number - optional and sparsely indexed |
phoneHType - PhoneType
|
Classification of home phone (mobile/landline/unknown). Affects SMS capabilities and communication preferences |
phoneWType - PhoneType
|
Classification of work phone (mobile/landline/unknown) |
street - String
|
Street address for mailing and service location purposes |
city - String
|
City for address completion and regional reporting |
state - String
|
State abbreviation for address completion and tax purposes |
zipCode - String
|
Postal code for address completion and service area validation |
dateOfBirth - datetime
|
Date of birth for age calculations and birthday reminders |
gender - UserGender
|
Gender identity for medical records and communication preferences |
tilledCustomerId - String
|
External payment processor customer ID for Tilled payment integration. Links user to payment methods and transaction history |
employeeInfo - EmployeeInfoSchema
|
Employee-specific information - present only for staff members. Contains role, permissions, and employment details |
clientInfo - ClientInfoSchema
|
Client-specific information - present only for pet owners. Links to family (Family) and contains client status and preferences |
createdAt - datetime
|
|
updatedAt - datetime
|
|
highlights - [Highlight!]
|
Search result highlighting information from MongoDB Atlas Search. Populated during search operations to show matched terms |
profilePictureMediaId - ID
|
Reference to profile picture in Media collection. Used for user avatars in UI and identification |
hideInCalendar - Boolean
|
Whether to exclude this employee from calendar views. Used for staff scheduling and availability display |
calendarOrder - Int
|
Display order for employees in calendar and scheduling interfaces. Lower numbers appear first in lists |
smsConsent - SmsConsent
|
SMS consent status for text message communications. Tracks opt-in/opt-out status for compliance with messaging regulations |
medicalHistoryFilters - [MedicalHistoryItemTypeEnum!]
|
Medical history item types to filter/hide from this user's view. Used to customize medical record visibility based on role or preference |
preferredCommunicationMethods - [PreferredCommunicationMethods!]
|
Preferred methods for clinic communications (call/text/email). Used to customize outreach and reminder delivery |
lastReminderSentAt - datetime
|
Timestamp of last reminder sent to prevent spam. Updated automatically when reminders are dispatched |
createdVia - PatientCreatedVia!
|
Source system where this user was originally created. Tracks whether user came from main app or client portal |
firstInvoiceDate - datetime
|
Date of user's first invoice for billing history tracking. Automatically set when first invoice is created |
lastInvoiceDate - datetime
|
Date of user's most recent invoice for billing activity tracking. Automatically updated when new invoices are created |
Example
{
"profilePicture": MediaSchema,
"id": "4",
"firstName": "xyz789",
"lastName": "xyz789",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "abc123",
"phoneW": "abc123",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "FEMALE",
"tilledCustomerId": "abc123",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"hideInCalendar": false,
"calendarOrder": 123,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"createdVia": "APP",
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
ClinicUserSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ClinicUserSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [ClinicUserSchemaEdge]
}
ClinicUserSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - ClinicUserSchema!
|
|
cursor - String!
|
Example
{
"node": ClinicUserSchema,
"cursor": "xyz789"
}
ClinicUserViewSchema
Fields
| Field Name | Description |
|---|---|
createdVia - PatientCreatedVia!
|
|
id - ID!
|
|
firstName - String!
|
|
lastName - String!
|
|
firstNameLowercase - String!
|
|
lastNameLowercase - String!
|
|
emailH - String
|
|
emailW - String
|
|
phoneH - String
|
|
phoneW - String
|
|
phoneHType - PhoneType
|
|
phoneWType - PhoneType
|
|
street - String
|
|
city - String
|
|
state - String
|
|
zipCode - String
|
|
dateOfBirth - datetime
|
|
gender - String
|
|
employeeInfo - EmployeeInfoSchema
|
|
clientInfo - ClientInfoSchema
|
|
createdAt - datetime
|
|
updatedAt - datetime
|
|
highlights - [Highlight!]
|
|
isEmployee - String
|
|
profilePicture - MediaSchema
|
|
hideInCalendar - Boolean
|
|
calendarOrder - Int
|
|
smsConsent - SmsConsent
|
|
medicalHistoryFilters - [MedicalHistoryItemTypeEnum!]
|
|
preferredCommunicationMethods - [PreferredCommunicationMethods!]
|
|
lastReminderSentAt - datetime
|
|
firstInvoiceDate - datetime
|
|
lastInvoiceDate - datetime
|
Example
{
"createdVia": "APP",
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"firstNameLowercase": "abc123",
"lastNameLowercase": "xyz789",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "xyz789",
"phoneW": "xyz789",
"phoneHType": "MOBILE",
"phoneWType": "MOBILE",
"street": "abc123",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": datetime,
"gender": "xyz789",
"employeeInfo": EmployeeInfoSchema,
"clientInfo": ClientInfoSchema,
"createdAt": datetime,
"updatedAt": datetime,
"highlights": [Highlight],
"isEmployee": "xyz789",
"profilePicture": MediaSchema,
"hideInCalendar": true,
"calendarOrder": 987,
"smsConsent": "OPT_IN",
"medicalHistoryFilters": ["SOAP_NOTE"],
"preferredCommunicationMethods": ["CALL"],
"lastReminderSentAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
ClinicUserViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ClinicUserViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [ClinicUserViewSchemaEdge]
}
ClinicUserViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - ClinicUserViewSchema!
|
|
cursor - String!
|
Example
{
"node": ClinicUserViewSchema,
"cursor": "abc123"
}
ColorInputSchema
ColorSchema
CommissionSettingCreateSchema
Fields
| Input Field | Description |
|---|---|
typeName - String
|
Human-readable name for the commission type (e.g., 'Preventative Care'). Optional but commonly used for display purposes in UI. Default = null |
typeCode - String
|
Unique code identifier for the commission type. Used for programmatic lookups and categorization. Default = null |
categoryName - String
|
Human-readable name for the commission category (e.g., 'Surgery'). Optional but commonly used for display purposes in UI. Default = null |
categoryCode - String
|
Unique code identifier for the commission category. Used for programmatic lookups and to group related treatments. Default = null |
treatmentId - ID
|
Foreign key reference to specific treatment (Treatment model). When set, commission applies to individual treatment; when null, applies to category. Mutually exclusive with category-based commission settings. Default = null |
commissionRate - Float!
|
Commission percentage as decimal (e.g., 0.15 for 15%). Required field - defaults to 0.0 but should be set to meaningful value. Applied to treatment price to calculate commission amount. Default = 0 |
userId - ID!
|
Foreign key reference to the clinic user (ClinicUser model). Required field - identifies which user receives this commission |
type - CommissionSettingType!
|
Enum defining whether commission applies to TREATMENT or CATEGORY. Required field - determines how commission calculation is applied. TREATMENT: specific treatment commission, CATEGORY: category-wide commission |
Example
{
"typeName": "xyz789",
"typeCode": "xyz789",
"categoryName": "xyz789",
"categoryCode": "abc123",
"treatmentId": 4,
"commissionRate": 123.45,
"userId": "4",
"type": "TREATMENT"
}
CommissionSettingSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema
|
|
id - ID!
|
MongoDB document ObjectID |
originalCommissionSettingId - ID
|
References the original commission setting when creating versioned copies. Used for maintaining version history - when updating a commission setting, a new record is created with this field pointing to the original |
typeName - String
|
Human-readable name for the commission type (e.g., 'Preventative Care'). Optional but commonly used for display purposes in UI |
typeCode - String
|
Unique code identifier for the commission type. Used for programmatic lookups and categorization |
categoryName - String
|
Human-readable name for the commission category (e.g., 'Surgery'). Optional but commonly used for display purposes in UI |
categoryCode - String
|
Unique code identifier for the commission category. Used for programmatic lookups and to group related treatments |
treatmentId - ID
|
Foreign key reference to specific treatment (Treatment model). When set, commission applies to individual treatment; when null, applies to category. Mutually exclusive with category-based commission settings |
commissionRate - Float!
|
Commission percentage as decimal (e.g., 0.15 for 15%). Required field - defaults to 0.0 but should be set to meaningful value. Applied to treatment price to calculate commission amount |
userId - ID!
|
Foreign key reference to the clinic user (ClinicUser model). Required field - identifies which user receives this commission |
type - CommissionSettingType!
|
Enum defining whether commission applies to TREATMENT or CATEGORY. Required field - determines how commission calculation is applied. TREATMENT: specific treatment commission, CATEGORY: category-wide commission |
deletedAt - datetime
|
Soft delete timestamp - when set, commission setting is considered deleted. Used instead of hard deletion to maintain audit trail and prevent data loss. Commission settings with deleted_at are excluded from active queries |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"treatment": TreatmentSchema,
"id": "4",
"originalCommissionSettingId": "4",
"typeName": "abc123",
"typeCode": "xyz789",
"categoryName": "abc123",
"categoryCode": "abc123",
"treatmentId": 4,
"commissionRate": 123.45,
"userId": 4,
"type": "TREATMENT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
CommissionSettingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TREATMENT"
CommissionSettingUpdateSchema
Example
{
"id": "4",
"typeName": "xyz789",
"typeCode": "xyz789",
"categoryName": "abc123",
"categoryCode": "xyz789",
"treatmentId": 4,
"commissionRate": 987.65
}
CommissionSettingViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
originalCommissionSettingId - ID
|
References the original commission setting when creating versioned copies. Used for maintaining version history - when updating a commission setting, a new record is created with this field pointing to the original |
typeName - String
|
Human-readable name for the commission type (e.g., 'Preventative Care'). Optional but commonly used for display purposes in UI |
typeCode - String
|
Unique code identifier for the commission type. Used for programmatic lookups and categorization |
categoryName - String
|
Human-readable name for the commission category (e.g., 'Surgery'). Optional but commonly used for display purposes in UI |
categoryCode - String
|
Unique code identifier for the commission category. Used for programmatic lookups and to group related treatments |
treatmentId - ID
|
Foreign key reference to specific treatment (Treatment model). When set, commission applies to individual treatment; when null, applies to category. Mutually exclusive with category-based commission settings |
treatment - TreatmentSchema
|
Populated treatment object via MongoDB lookup pipeline (Treatment model). Contains full treatment details when treatment_id is set |
type - CommissionSettingType!
|
Enum defining whether commission applies to TREATMENT or CATEGORY. Required field - determines how commission calculation is applied. TREATMENT: specific treatment commission, CATEGORY: category-wide commission |
commissionRate - Float!
|
Commission percentage as decimal (e.g., 0.15 for 15%). Required field - defaults to 0.0 but should be set to meaningful value. Applied to treatment price to calculate commission amount |
userId - ID!
|
Foreign key reference to the clinic user (ClinicUser model). Required field - identifies which user receives this commission |
user - ClinicUserSchema!
|
Populated user object via MongoDB lookup pipeline (ClinicUser model). Contains full user details for the commission recipient |
deletedAt - datetime
|
Soft delete timestamp - when set, commission setting is considered deleted. Used instead of hard deletion to maintain audit trail and prevent data loss. Commission settings with deleted_at are excluded from active queries |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"originalCommissionSettingId": 4,
"typeName": "xyz789",
"typeCode": "xyz789",
"categoryName": "xyz789",
"categoryCode": "xyz789",
"treatmentId": "4",
"treatment": TreatmentSchema,
"type": "TREATMENT",
"commissionRate": 987.65,
"userId": 4,
"user": ClinicUserSchema,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
CommissionSettingsByUserSchema
CommonItemSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema
|
|
treatmentId - ID
|
|
instanceId - ID!
|
|
name - String!
|
|
unit - UnitEnum!
|
|
pricePerUnit - Int!
|
|
adminFee - Int!
|
|
minimumCharge - Int!
|
|
isTaxable - Boolean!
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
customPrice - Int
|
Custom price override for this item |
discountRates - [DiscountRateSchema!]
|
Discount rates applicable to this item |
labId - ID
|
Reference to associated lab record |
vaccineId - ID
|
Reference to associated vaccine record (Vaccine model) |
priceType - PriceTypeEnum
|
Price calculation type for this item |
markupFactor - Decimal
|
Markup factor for price calculation |
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
Historical high cost per unit for inventory |
inventoryLatestCostPerUnit - Int
|
Latest cost per unit for inventory |
groupDiscount - ItemGroupDiscountSchema
|
Group discount applied to this item |
isCustomTreatment - Boolean
|
Whether this is a custom treatment |
customTreatmentIsRxScript - Boolean
|
Whether custom treatment is an RX script |
clinicCostPerUnit - Int
|
Clinic cost per unit |
useVendorCost - Boolean
|
Whether to use vendor cost for pricing |
vendorListPrice - Int
|
Vendor list price |
inventoryLotId - String
|
Inventory lot ID |
inventoryManufacturer - String
|
Inventory manufacturer |
parentBundleInfo - ParentBundleInfoSchema
|
Information about the parent bundle if this item is part of a bundle |
hideItem - Boolean
|
Whether to hide the item from estimates and invoices pdf exports |
Possible Types
| CommonItemSchema Types |
|---|
Example
{
"treatment": TreatmentSchema,
"treatmentId": 4,
"instanceId": "4",
"name": "abc123",
"unit": "ML",
"pricePerUnit": 987,
"adminFee": 987,
"minimumCharge": 987,
"isTaxable": true,
"isPstTaxable": true,
"instructions": "abc123",
"customPrice": 123,
"discountRates": [DiscountRateSchema],
"labId": 4,
"vaccineId": "4",
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": false,
"useHistoricalHigh": true,
"nonBillable": true,
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 123,
"groupDiscount": ItemGroupDiscountSchema,
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 987,
"useVendorCost": false,
"vendorListPrice": 123,
"inventoryLotId": "xyz789",
"inventoryManufacturer": "xyz789",
"parentBundleInfo": ParentBundleInfoSchema,
"hideItem": true
}
CommonNoteSchema
Fields
| Field Name | Description |
|---|---|
patientVitals - PatientVitalSchema
|
|
estimates - [EstimateSchema!]
|
|
invoices - [InvoiceViewSchema!]
|
|
vitals - [PatientVitalSchema!]
|
|
addendums - [AddendumSchema!]
|
|
media - [MediaSchema!]
|
|
creator - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patient - PatientSchema!
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
noteType - NoteType
|
Determines the specific note type - affects display, validation, and auto-lock behavior. Each note type has different auto-lock timeouts and specific business logic |
patientId - ID!
|
Required reference to the patient this note belongs to (ClinicPatient model). Used for patient history tracking and medical record organization |
providerId - ID
|
The primary veterinary provider responsible for this note (ClinicUser model). Auto-populated from appointment assigned employee if they are a provider. Falls back to default vet assigned to patient for current day if no appointment |
creatorUid - ID
|
The user who originally created this note (ClinicUser model). Used for audit trails and permission checks |
techUid - ID
|
The veterinary technician associated with this note (ClinicUser model). Typically assigned during appointment scheduling or note creation |
appointmentId - ID
|
Reference to the appointment this note was created from (Appointment model). Used to inherit appointment details like assigned staff and appointment type |
appointmentTypeId - ID
|
Reference to the type of appointment this note relates to (AppointmentType model). Auto-populated from linked appointment for categorization and reporting |
treatments - [PrescribedTreatmentSchema!]
|
List of prescribed treatments, medications, and procedures for this note. Syncs to invoicing system when auto-charge capture is enabled. Each treatment includes quantity, instructions, pricing, and fulfillment details |
followUps - [FollowUpSchema!]
|
List of recommended follow-up appointments and care instructions. Each follow-up includes appointment type, reason, and recommended timing |
status - SoapStatusEnum
|
Current workflow status of the note - controls editability and triggers side effects. DRAFT: editable, auto-locks after clinic-configured hours. FINAL: locked, triggers patient history updates and patient annotation creation. VOIDED/DELETED: reverses patient annotations and marks as inactive |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
autolockCreatedAt - datetime
|
Optional reference datetime for auto-lock functionality. When set, this datetime is used instead of created_at for calculating auto-lock timing (autolock_created_at + autolock_hours). Allows for custom auto-lock reference timing per note |
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
List of patient body diagrams with annotations for visual medical documentation. When note is finalized, default body diagram annotations are copied to patient annotations. Supports multiple diagram types including body maps and custom medical illustrations |
Example
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [SoapSurgeryPatientDiagramSchema]
}
CommonNoteUpdateMetaSchema
Fields
| Input Field | Description |
|---|---|
lastUpdatedAt - datetime
|
Example
{"lastUpdatedAt": datetime}
CommonNoteVoidSchema
CommunicationCreateSchema
Fields
| Input Field | Description |
|---|---|
clientId - ID!
|
Reference to the client (pet owner) involved in this communication. Links to User model in users collection. Required for creating communication records |
patientId - ID!
|
Reference to the patient (pet) this communication is about. Links to Patient model in patients collection. Required for creating communication records and patient history tracking |
employeeId - ID!
|
Reference to the employee who handled this communication. Links to User model in users collection. Required for tracking which staff member was involved |
communicationType - CommunicationType!
|
Type of communication method used (phone, email, in-person, fax, verbal). Required field that determines how the communication took place. TEXT type is deprecated and should not be used for new communications |
communication - String
|
The actual content/message of the communication. Optional but typically contains the details of what was discussed. Used in display_string method, truncated to first 120 characters for display. Default = null |
contactDatetime - datetime
|
When the communication actually took place. Optional field - may be different from created_at if logged after the fact. Used as display_date in patient history records. Default = null |
mediaId - ID
|
Optional reference to attached media file. Links to Media model when communication includes files/attachments. Used by service layer to populate media details. Default = null |
mangoWebhookRequestId - String
|
Reference to the MangoWebhookRequest that triggered this communication. Links call analytics data to communication records. Default = null |
Example
{
"clientId": "4",
"patientId": 4,
"employeeId": "4",
"communicationType": "PHONE",
"communication": "xyz789",
"contactDatetime": datetime,
"mediaId": 4,
"mangoWebhookRequestId": "abc123"
}
CommunicationSchema
Fields
| Field Name | Description |
|---|---|
client - ClinicUserSchema
|
|
employee - ClinicUserSchema
|
|
patient - PatientSchema
|
|
media - MediaSchema
|
|
callAnalytics - CallSummaryAnalyticsSchema
|
|
communicationId - ID!
|
|
clientId - ID!
|
Reference to the client (pet owner) involved in this communication. Links to User model in users collection. Required for creating communication records |
patientId - ID!
|
Reference to the patient (pet) this communication is about. Links to Patient model in patients collection. Required for creating communication records and patient history tracking |
employeeId - ID!
|
Reference to the employee who handled this communication. Links to User model in users collection. Required for tracking which staff member was involved |
communicationType - CommunicationType!
|
Type of communication method used (phone, email, in-person, fax, verbal). Required field that determines how the communication took place. TEXT type is deprecated and should not be used for new communications |
communication - String!
|
The actual content/message of the communication. Optional but typically contains the details of what was discussed. Used in display_string method, truncated to first 120 characters for display |
contactDatetime - datetime
|
When the communication actually took place. Optional field - may be different from created_at if logged after the fact. Used as display_date in patient history records |
status - CommunicationStatusEnum!
|
Current status of the communication record. Defaults to OPEN when created. Can be changed to VOIDED (with void_reason) or DELETED. Status changes affect patient history tracking |
mediaId - ID
|
Optional reference to attached media file. Links to Media model when communication includes files/attachments. Used by service layer to populate media details |
mangoWebhookRequestId - String
|
Reference to the MangoWebhookRequest that triggered this communication. Links call analytics data to communication records |
voidReason - String
|
Reason provided when communication is voided. Required when status is changed to VOIDED. Helps track why communications were invalidated |
createdAt - datetime
|
|
updatedAt - datetime
|
Example
{
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"patient": PatientSchema,
"media": MediaSchema,
"callAnalytics": CallSummaryAnalyticsSchema,
"communicationId": "4",
"clientId": 4,
"patientId": 4,
"employeeId": 4,
"communicationType": "PHONE",
"communication": "abc123",
"contactDatetime": datetime,
"status": "OPEN",
"mediaId": "4",
"mangoWebhookRequestId": "abc123",
"voidReason": "abc123",
"createdAt": datetime,
"updatedAt": datetime
}
CommunicationSchemaEstimateSchemaFamilyViewSchemaInvoiceViewSchemaInvoiceSchemaLabSchemaConversationMessageSchemaRxScriptSchemaSoapSchemaSurgerySchemaVisitNoteSchemaOrderNoteSchemaVaccineSchemaDischargeDocumentSchema
Example
CommunicationSchema
CommunicationSchemaEstimateSchemaFamilyViewSchemaInvoiceViewSchemaLabSchemaLabResultSchemaPrescriptionOrderSchemaPrescriptionFillSchemaMiscNoteSchemaConversationMessageSchemaRxScriptSchemaSoapSchemaSurgerySchemaVisitNoteSchemaOrderNoteSchemaVaccineSchemaMediaSchemaFormSubmissionViewSchemaXraySchemaPatientVitalSchemaTaskSchemaLinkSchemaTreatmentPlanViewSchemaEmailLogSchema
Types
| Union Types |
|---|
Example
CommunicationSchema
CommunicationStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
CommunicationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PHONE"
CommunicationUpdateSchema
Example
{
"communicationId": "4",
"clientId": "4",
"employeeId": "4",
"communicationType": "PHONE",
"communication": "abc123",
"contactDatetime": datetime
}
CommunicationVoidSchema
ComparisonOperators
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQ"
CompoundInventoryItemCreateSchema
CompoundInventoryItemSchema
ConditionLogic
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
ConditionOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQUALS"
ConversationMessageSchema
Fields
| Field Name | Description |
|---|---|
updateType - ConversationMessageUpdateType
|
|
conversation - ConversationSchema!
|
|
employee - ClinicUserSchema
|
|
medias - [MediaSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
messageType - MessageType!
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
fromPhoneNumber - String!
|
|
toPhoneNumber - String!
|
|
conversationId - ID!
|
|
body - String
|
|
mediaIds - [ID!]
|
|
patientHistoryItemIds - [ID!]!
|
|
employeeId - ID
|
|
status - MessageStatus
|
Example
{
"updateType": "NEW",
"conversation": ConversationSchema,
"employee": ClinicUserSchema,
"medias": [MediaSchema],
"id": 4,
"messageType": "SMS",
"createdAt": datetime,
"updatedAt": datetime,
"fromPhoneNumber": "xyz789",
"toPhoneNumber": "abc123",
"conversationId": 4,
"body": "abc123",
"mediaIds": ["4"],
"patientHistoryItemIds": ["4"],
"employeeId": "4",
"status": "ACCEPTED"
}
ConversationMessageSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ConversationMessageSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [ConversationMessageSchemaEdge]
}
ConversationMessageSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - ConversationMessageSchema!
|
|
cursor - String!
|
Example
{
"node": ConversationMessageSchema,
"cursor": "xyz789"
}
ConversationMessageUpdateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NEW"
ConversationParticipantSchema
Example
{
"employee": ClinicUserSchema,
"employeeId": "4",
"assignedAt": datetime,
"assignedMessageId": 4,
"readAt": datetime,
"unreadCount": 987
}
ConversationSchema
Fields
| Field Name | Description |
|---|---|
assignedParticipants - [ConversationParticipantSchema!]!
|
|
updateType - ConversationUpdateType
|
|
participants - [ConversationParticipantSchema!]!
|
|
messages - ConversationMessageSchemaConnection!
|
|
Arguments
|
|
client - ClinicUserSchema
|
|
id - ID!
|
MongoDB document ObjectID |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
clientId - ID
|
|
unknownPhoneNumber - String
|
|
isArchived - Boolean!
|
|
readAt - datetime
|
|
unreadCount - Int
|
|
lastMessageAt - datetime
|
|
lastSavedAt - datetime
|
|
Example
{
"assignedParticipants": [ConversationParticipantSchema],
"updateType": "ASSIGNED",
"participants": [ConversationParticipantSchema],
"messages": ConversationMessageSchemaConnection,
"client": ClinicUserSchema,
"id": 4,
"createdAt": datetime,
"updatedAt": datetime,
"clientId": "4",
"unknownPhoneNumber": "xyz789",
"isArchived": false,
"readAt": datetime,
"unreadCount": 987,
"lastMessageAt": datetime,
"lastSavedAt": datetime
}
ConversationSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ConversationSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [ConversationSchemaEdge]
}
ConversationSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - ConversationSchema!
|
|
cursor - String!
|
Example
{
"node": ConversationSchema,
"cursor": "xyz789"
}
ConversationUpdateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSIGNED"
CreateAINoteSummarySchema
CreateCardPresentSessionSchema
CreateFreemiumWithUserSchema
CreateNoteFromEstimateInput
Fields
| Input Field | Description |
|---|---|
estimateId - ID!
|
|
providerId - ID
|
|
bundleOptions - BundleOptionsInput
|
Example
{
"estimateId": "4",
"providerId": 4,
"bundleOptions": BundleOptionsInput
}
CreateProviderInput
Fields
| Input Field | Description |
|---|---|
employeeId - ID!
|
|
labVendor - LabVendor!
|
Example
{"employeeId": 4, "labVendor": "OTHER"}
CreateScheduledEventsSchema
Example
{
"id": 4,
"instanceId": 4,
"treatmentPlanTaskId": "abc123",
"scheduleType": "SCHEDULED",
"startAtHour": 987,
"numHoursBetween": 987,
"numTreatments": 123,
"instructions": "xyz789"
}
CreateSubscriptionInput
Example
{
"clientId": 4,
"price": 123,
"intervalUnit": "abc123",
"intervalCount": 987,
"paymentMethodId": "xyz789",
"currency": "abc123",
"metadata": {},
"platformFeeAmount": 123,
"billingCycleAnchor": datetime
}
CreateTreatmentPlanFromMedicalNoteSchema
Fields
| Input Field | Description |
|---|---|
originId - ID!
|
|
treatments - [PrescribedTreatmentCreateSchema!]!
|
|
originType - TreatmentPlanOriginType!
|
Example
{
"originId": 4,
"treatments": [PrescribedTreatmentCreateSchema],
"originType": "SOAP"
}
Currency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUD"
CursorMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FORWARD"
DataChange
Fields
| Field Name | Description |
|---|---|
type - DataChangeType!
|
|
documentId - ID
|
Example
{"type": "TREATMENT", "documentId": "4"}
DataChangeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TREATMENT"
DateFilter
Fields
| Input Field | Description |
|---|---|
value1 - datetime!
|
|
operator - ComparisonOperators!
|
|
value2 - datetime
|
Example
{
"value1": datetime,
"operator": "EQ",
"value2": datetime
}
Decimal
Example
Decimal
DecimalFilter
Fields
| Input Field | Description |
|---|---|
value1 - Decimal!
|
|
operator - ComparisonOperators!
|
|
value2 - String
|
Example
{
"value1": Decimal,
"operator": "EQ",
"value2": "abc123"
}
DeclinedTreatmentFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
clientId - ListObjectIdFilter
|
|
vetUid - ObjectIdFilter
|
|
treatmentId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
treatmentDotName - StrFilter
|
|
treatmentDotCategory - StrFilter
|
|
treatmentDotType - StrFilter
|
|
patientDotSpecies - StrFilter
|
|
patientDotBreed - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"clientId": ListObjectIdFilter,
"vetUid": ObjectIdFilter,
"treatmentId": ListObjectIdFilter,
"createdAt": DateFilter,
"treatmentDotName": StrFilter,
"treatmentDotCategory": StrFilter,
"treatmentDotType": StrFilter,
"patientDotSpecies": StrFilter,
"patientDotBreed": StrFilter
}
DeclinedTreatmentViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
soapId - ID!
|
|
treatmentId - ID!
|
|
instanceId - ID
|
|
createdAt - datetime!
|
|
treatment - TreatmentSchema
|
|
patient - PatientSchema
|
|
patientId - ID
|
|
providerId - ID
|
|
provider - ClinicUserSchema
|
|
client - ClinicUserSchema
|
Example
{
"id": "xyz789",
"soapId": "4",
"treatmentId": "4",
"instanceId": 4,
"createdAt": datetime,
"treatment": TreatmentSchema,
"patient": PatientSchema,
"patientId": 4,
"providerId": "4",
"provider": ClinicUserSchema,
"client": ClinicUserSchema
}
DeclinedTreatmentViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [DeclinedTreatmentViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [DeclinedTreatmentViewSchemaEdge]
}
DeclinedTreatmentViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - DeclinedTreatmentViewSchema!
|
|
cursor - String!
|
Example
{
"node": DeclinedTreatmentViewSchema,
"cursor": "xyz789"
}
DiagnosisBasicSchema
DiagnosisCreateSchema
Fields
| Input Field | Description |
|---|---|
dischargeDocuments - [DischargeDocumentUpdateSchema!]
|
|
name - String!
|
|
source - DiagnosisSourceEnum!
|
|
creatorId - ID
|
Example
{
"dischargeDocuments": [DischargeDocumentUpdateSchema],
"name": "abc123",
"source": "AAHA",
"creatorId": 4
}
DiagnosisEntry
DiagnosisEntrySchema
Fields
| Field Name | Description |
|---|---|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
|
name - String!
|
|
source - DiagnosisSourceEnum!
|
|
dischargeDocumentIds - [ID!]!
|
Example
{
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"name": "xyz789",
"source": "AAHA",
"dischargeDocumentIds": [4]
}
DiagnosisLinkInput
DiagnosisSchema
Fields
| Field Name | Description |
|---|---|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
name - String!
|
|
source - DiagnosisSourceEnum!
|
|
dischargeDocumentIds - [ID!]!
|
|
creatorId - ID
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"name": "abc123",
"source": "AAHA",
"dischargeDocumentIds": [4],
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
DiagnosisSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [DiagnosisSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [DiagnosisSchemaEdge]
}
DiagnosisSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - DiagnosisSchema!
|
|
cursor - String!
|
Example
{
"node": DiagnosisSchema,
"cursor": "xyz789"
}
DiagnosisSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AAHA"
DiagnosisUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
source - String
|
|
dischargeDocuments - [DischargeDocumentUpdateSchema!]
|
|
creatorId - ID
|
Example
{
"id": "4",
"name": "xyz789",
"source": "xyz789",
"dischargeDocuments": [DischargeDocumentUpdateSchema],
"creatorId": "4"
}
DiagnosisViewFilterSchema
Fields
| Input Field | Description |
|---|---|
name - StrFilter
|
|
source - StrFilter
|
|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"name": StrFilter,
"source": StrFilter,
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
DirectOnlineSchedulingOptionsSchema
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
approvalRequired - Boolean!
|
|
maxDaysInAdvance - Int!
|
|
minHoursBeforeAppt - Int!
|
|
minMinutesBetweenAppt - Int!
|
|
introTitle - String
|
|
introContent - String
|
|
bookingFeePolicy - String
|
|
speciesAllowed - [String!]
|
|
allowNewClientsOnlineAppointments - Boolean
|
|
enableOnlineAppointmentsNotifications - Boolean
|
|
onlineAppointmentsNotificationsEmail - String
|
Example
{
"enabled": true,
"approvalRequired": true,
"maxDaysInAdvance": 123,
"minHoursBeforeAppt": 987,
"minMinutesBetweenAppt": 987,
"introTitle": "xyz789",
"introContent": "xyz789",
"bookingFeePolicy": "xyz789",
"speciesAllowed": ["xyz789"],
"allowNewClientsOnlineAppointments": true,
"enableOnlineAppointmentsNotifications": false,
"onlineAppointmentsNotificationsEmail": "xyz789"
}
DirectOnlineSchedulingOptionsUpdateSchema
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
|
approvalRequired - Boolean
|
|
maxDaysInAdvance - Int
|
|
minHoursBeforeAppt - Int
|
|
minMinutesBetweenAppt - Int
|
|
introTitle - String
|
|
introContent - String
|
|
bookingFeePolicy - String
|
|
speciesAllowed - [String!]
|
|
allowNewClientsOnlineAppointments - Boolean
|
|
enableOnlineAppointmentsNotifications - Boolean
|
|
onlineAppointmentsNotificationsEmail - String
|
Example
{
"enabled": true,
"approvalRequired": false,
"maxDaysInAdvance": 987,
"minHoursBeforeAppt": 987,
"minMinutesBetweenAppt": 987,
"introTitle": "xyz789",
"introContent": "abc123",
"bookingFeePolicy": "abc123",
"speciesAllowed": ["abc123"],
"allowNewClientsOnlineAppointments": false,
"enableOnlineAppointmentsNotifications": false,
"onlineAppointmentsNotificationsEmail": "xyz789"
}
DischargeDocumentCreateSchema
Fields
| Input Field | Description |
|---|---|
fileName - String!
|
The original filename of the uploaded discharge document file. Used for display purposes and tracking the source file |
documentName - String!
|
Human-readable name for the discharge document. Used for display in UI and organization of documents |
mediaId - ID!
|
Reference to the actual file stored in the media system (Media model). Links to the physical file content that can be downloaded or viewed. Required field - every discharge document must have associated media |
species - String!
|
The animal species this discharge document applies to. Used for filtering and categorizing documents by species type. Required field for proper document organization |
creatorId - ID
|
Reference to the clinic user who created this discharge document (ClinicUser model). Optional field - can be null if creator is unknown or system-generated. Used for audit trails and permission checking. Default = null |
Example
{
"fileName": "xyz789",
"documentName": "xyz789",
"mediaId": 4,
"species": "xyz789",
"creatorId": 4
}
DischargeDocumentCreateWithLinksSchema
Fields
| Input Field | Description |
|---|---|
fileName - String!
|
|
documentName - String!
|
|
mediaId - ID!
|
|
species - String!
|
|
creatorId - ID
|
|
linkedDiagnoses - [DiagnosisLinkInput!]
|
|
linkedTreatments - [TreatmentLinkInput!]
|
Example
{
"fileName": "abc123",
"documentName": "abc123",
"mediaId": "4",
"species": "xyz789",
"creatorId": 4,
"linkedDiagnoses": [DiagnosisLinkInput],
"linkedTreatments": [TreatmentLinkInput]
}
DischargeDocumentSchema
Fields
| Field Name | Description |
|---|---|
linkedDiagnoses - [DiagnosisBasicSchema!]!
|
|
linkedTreatments - [TreatmentBasicSchema!]!
|
|
id - ID!
|
MongoDB document ObjectID |
fileName - String!
|
The original filename of the uploaded discharge document file. Used for display purposes and tracking the source file |
documentName - String!
|
Human-readable name for the discharge document. Used for display in UI and organization of documents |
mediaId - ID!
|
Reference to the actual file stored in the media system (Media model). Links to the physical file content that can be downloaded or viewed. Required field - every discharge document must have associated media |
species - String!
|
The animal species this discharge document applies to. Used for filtering and categorizing documents by species type. Required field for proper document organization |
creatorId - ID
|
Reference to the clinic user who created this discharge document (ClinicUser model). Optional field - can be null if creator is unknown or system-generated. Used for audit trails and permission checking |
deletedAt - datetime
|
Soft deletion timestamp - when set, document is considered deleted. Used instead of hard deletion to maintain audit trails and referential integrity. Documents are filtered out when this field is not null |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"linkedDiagnoses": [DiagnosisBasicSchema],
"linkedTreatments": [TreatmentBasicSchema],
"id": 4,
"fileName": "abc123",
"documentName": "abc123",
"mediaId": "4",
"species": "abc123",
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
DischargeDocumentSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [DischargeDocumentSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [DischargeDocumentSchemaEdge]
}
DischargeDocumentSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - DischargeDocumentSchema!
|
|
cursor - String!
|
Example
{
"node": DischargeDocumentSchema,
"cursor": "abc123"
}
DischargeDocumentUpdateSchema
DischargeDocumentViewFilterSchema
Fields
| Input Field | Description |
|---|---|
fileName - StrFilter
|
|
species - StrFilter
|
|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"fileName": StrFilter,
"species": StrFilter,
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
DiscountRateCreateSchema
DiscountRateSchema
DurationUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MINUTES"
EftDebitSchema
EmailLogCreateSchema
Example
{
"sender": "xyz789",
"receiverEmails": ["xyz789"],
"patientId": "4",
"subject": "abc123",
"emailTemplateName": "xyz789",
"emailTemplateData": {},
"emailContent": "xyz789",
"attachmentIds": [4]
}
EmailLogFilterSchema
Fields
| Input Field | Description |
|---|---|
createdAt - DateFilter
|
|
patientId - ID
|
Example
{"createdAt": DateFilter, "patientId": 4}
EmailLogSchema
Fields
| Field Name | Description |
|---|---|
attachments - [MediaSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
sender - String!
|
|
receiverEmails - [String!]!
|
|
patientId - ID
|
|
subject - String!
|
|
emailTemplateName - String!
|
|
emailTemplateData - JSON!
|
|
emailContent - String!
|
|
attachmentIds - [ID!]
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"attachments": [MediaSchema],
"id": 4,
"sender": "xyz789",
"receiverEmails": ["xyz789"],
"patientId": 4,
"subject": "abc123",
"emailTemplateName": "abc123",
"emailTemplateData": {},
"emailContent": "abc123",
"attachmentIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime
}
EmailLogSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [EmailLogSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [EmailLogSchemaEdge]
}
EmailLogSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - EmailLogSchema!
|
|
cursor - String!
|
Example
{
"node": EmailLogSchema,
"cursor": "xyz789"
}
EmailOrPrintTodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
Example
{"id": 4, "completed": true, "todoType": "VACCINE_CERTIFICATE"}
EmailOrPrintTodoSchemaRxScriptTodoSchemaVaccineCertificateTodoSchemaLabTodoSchemaScheduleFollowUpTodoSchemaPaymentTodoSchema
Example
EmailOrPrintTodoSchema
EmailTemplateCreateSchema
Example
{
"name": "abc123",
"description": "abc123",
"subject": "xyz789",
"body": "abc123",
"bodyJson": "abc123",
"footer": "abc123",
"footerJson": "abc123",
"replyTo": "xyz789",
"linkedFormIds": [4]
}
EmailTemplateDuplicateSchema
EmailTemplateSchema
Fields
| Field Name | Description |
|---|---|
postFooter - String
|
|
availableVariables - JSON!
|
|
id - ID!
|
MongoDB document ObjectID |
name - String!
|
|
description - String
|
|
key - String!
|
|
templateKey - String
|
|
enabled - Boolean
|
|
type - EmailTemplateType!
|
|
replyTo - String
|
|
subject - String!
|
|
body - String!
|
|
bodyJson - String
|
|
footer - String
|
|
footerJson - String
|
|
linkedFormIds - [ID!]!
|
|
createdAt - datetime
|
|
updatedAt - datetime
|
Example
{
"postFooter": "xyz789",
"availableVariables": {},
"id": 4,
"name": "xyz789",
"description": "abc123",
"key": "xyz789",
"templateKey": "abc123",
"enabled": true,
"type": "SYSTEM",
"replyTo": "abc123",
"subject": "abc123",
"body": "abc123",
"bodyJson": "xyz789",
"footer": "xyz789",
"footerJson": "abc123",
"linkedFormIds": ["4"],
"createdAt": datetime,
"updatedAt": datetime
}
EmailTemplateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SYSTEM"
EmailTemplateUpdateSchema
Example
{
"id": "4",
"name": "abc123",
"enabled": true,
"replyTo": "abc123",
"subject": "xyz789",
"body": "abc123",
"bodyJson": "abc123",
"footer": "abc123",
"footerJson": "abc123",
"linkedFormIds": ["4"],
"updatedAt": datetime
}
EmployeeCalendarOrderSchema
Fields
| Input Field | Description |
|---|---|
userIds - [ID!]!
|
Example
{"userIds": [4]}
EmployeeCreateSchema
Fields
| Input Field | Description |
|---|---|
firstName - String!
|
|
lastName - String!
|
|
emailH - String!
|
|
phoneH - String!
|
|
emailW - String
|
|
phoneW - String
|
|
street - String
|
|
city - String
|
|
state - String
|
|
zipCode - String
|
|
dateOfBirth - String
|
|
gender - UserGender
|
|
employeeInfo - EmployeeInfoCreateSchema
|
|
hideInCalendar - Boolean
|
|
calendarOrder - Int
|
Example
{
"firstName": "abc123",
"lastName": "abc123",
"emailH": "xyz789",
"phoneH": "abc123",
"emailW": "xyz789",
"phoneW": "xyz789",
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"zipCode": "abc123",
"dateOfBirth": "xyz789",
"gender": "FEMALE",
"employeeInfo": EmployeeInfoCreateSchema,
"hideInCalendar": false,
"calendarOrder": 123
}
EmployeeInfoCreateSchema
Fields
| Input Field | Description |
|---|---|
username - String!
|
|
employeeExtId - String
|
|
jobTitle - JobTitle
|
|
role - Role
|
|
rolePermission - String
|
|
employeeStatus - UserStatus
|
|
licenseNumber - String
|
|
taskFilter - String
|
|
hl7iProviderIds - [Hl7iProviderIdCreateSchema!]
|
|
antechV6ProviderId - String
|
|
quickPin - String
|
|
providerCodes - [ProviderCode!]
|
|
isProvider - Boolean
|
|
allMessages - Boolean
|
|
mangoExtension - String
|
|
autoSignVaccineCertificates - Boolean
|
|
bypassIpRestrictionEnabled - Boolean
|
|
signature - String
|
|
deaNumber - String
|
Example
{
"username": "abc123",
"employeeExtId": "abc123",
"jobTitle": "OWNER",
"role": "GUEST",
"rolePermission": "abc123",
"employeeStatus": "ACTIVE",
"licenseNumber": "abc123",
"taskFilter": "abc123",
"hl7iProviderIds": [Hl7iProviderIdCreateSchema],
"antechV6ProviderId": "abc123",
"quickPin": "xyz789",
"providerCodes": ["ER"],
"isProvider": false,
"allMessages": true,
"mangoExtension": "abc123",
"autoSignVaccineCertificates": false,
"bypassIpRestrictionEnabled": true,
"signature": "abc123",
"deaNumber": "xyz789"
}
EmployeeInfoSchema
Fields
| Field Name | Description |
|---|---|
username - String
|
Display name for employee identification - required and must be non-empty |
employeeExtId - String
|
Unique external employee identifier - required and validated for uniqueness. Throws validation error if duplicate exists during insert/update |
jobTitle - JobTitle
|
Employee's role/position for access control and display purposes |
role - Role
|
Permission level determining system access and capabilities |
rolePermission - String
|
Additional role-based permissions string for fine-grained access control |
employeeStatus - UserStatus
|
Employment status - defaults to ACTIVE, used for filtering active staff |
licenseNumber - String
|
Professional license number for veterinarians and certified technicians |
deaNumber - String
|
DEA (Drug Enforcement Administration) number for prescribing controlled substances |
taskFilter - String
|
Filter criteria for task assignments and visibility |
hl7iProviderIds - [Hl7iProviderIdSchema!]
|
Lab integration provider IDs for HL7i lab result routing. Maps specific lab vendors to provider identifiers |
ellieProviderId - String
|
Provider identifier for Ellie lab integration |
antechV6ProviderId - String
|
Provider identifier for Antech v6 lab integration |
quickPin - String
|
Quick PIN for fast authentication in clinical workflows |
providerCodes - [ProviderCode!]
|
Provider classification codes for different service types |
isProvider - Boolean
|
Whether this employee is a medical provider (vet/tech) for treatment assignments |
allMessages - Boolean
|
Whether employee receives all system messages regardless of assignment |
bypassIpRestrictionEnabled - Boolean
|
Whether can bypass IP restrictions for this staff member |
mangoExtension - String
|
Phone system extension number for internal communications |
autoSignVaccineCertificates - Boolean
|
Whether to automatically add this provider's signature to vaccine certificates where they are the provider |
signature - String
|
Base64 encoded digital signature image for use on vaccine certificates and other documents |
Example
{
"username": "abc123",
"employeeExtId": "abc123",
"jobTitle": "OWNER",
"role": "GUEST",
"rolePermission": "abc123",
"employeeStatus": "ACTIVE",
"licenseNumber": "xyz789",
"deaNumber": "abc123",
"taskFilter": "abc123",
"hl7iProviderIds": [Hl7iProviderIdSchema],
"ellieProviderId": "xyz789",
"antechV6ProviderId": "xyz789",
"quickPin": "xyz789",
"providerCodes": ["ER"],
"isProvider": true,
"allMessages": false,
"bypassIpRestrictionEnabled": false,
"mangoExtension": "xyz789",
"autoSignVaccineCertificates": false,
"signature": "xyz789"
}
EmployeeInfoUpdateSchema
Fields
| Input Field | Description |
|---|---|
username - String
|
|
employeeExtId - String
|
|
jobTitle - JobTitle
|
|
role - Role
|
|
rolePermission - String
|
|
employeeStatus - UserStatus
|
|
licenseNumber - String
|
|
taskFilter - String
|
|
hl7iProviderIds - [Hl7iProviderIdUpdateSchema!]
|
|
antechV6ProviderId - String
|
|
quickPin - String
|
|
providerCodes - [ProviderCode!]
|
|
isProvider - Boolean
|
|
allMessages - Boolean
|
|
mangoExtension - String
|
|
autoSignVaccineCertificates - Boolean
|
|
bypassIpRestrictionEnabled - Boolean
|
|
signature - String
|
|
deaNumber - String
|
Example
{
"username": "abc123",
"employeeExtId": "xyz789",
"jobTitle": "OWNER",
"role": "GUEST",
"rolePermission": "xyz789",
"employeeStatus": "ACTIVE",
"licenseNumber": "xyz789",
"taskFilter": "xyz789",
"hl7iProviderIds": [Hl7iProviderIdUpdateSchema],
"antechV6ProviderId": "abc123",
"quickPin": "xyz789",
"providerCodes": ["ER"],
"isProvider": true,
"allMessages": false,
"mangoExtension": "xyz789",
"autoSignVaccineCertificates": false,
"bypassIpRestrictionEnabled": false,
"signature": "xyz789",
"deaNumber": "abc123"
}
EmployeePinUpdateSchema
EmployeeUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
firstName - String
|
|
lastName - String
|
|
emailH - String
|
|
emailW - String
|
|
phoneH - String
|
|
phoneW - String
|
|
username - String
|
|
street - String
|
|
city - String
|
|
state - String
|
|
zipCode - String
|
|
dateOfBirth - String
|
|
gender - UserGender
|
|
employeeInfo - EmployeeInfoUpdateSchema
|
|
profilePictureMediaId - ID
|
|
hideInCalendar - Boolean
|
|
calendarOrder - Int
|
|
medicalHistoryFilters - [MedicalHistoryItemTypeEnum!]
|
Example
{
"id": "4",
"firstName": "xyz789",
"lastName": "xyz789",
"emailH": "abc123",
"emailW": "xyz789",
"phoneH": "abc123",
"phoneW": "xyz789",
"username": "xyz789",
"street": "abc123",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"dateOfBirth": "abc123",
"gender": "FEMALE",
"employeeInfo": EmployeeInfoUpdateSchema,
"profilePictureMediaId": "4",
"hideInCalendar": false,
"calendarOrder": 123,
"medicalHistoryFilters": ["SOAP_NOTE"]
}
EstimateApproveSchema
Fields
| Input Field | Description |
|---|---|
estimateId - ID!
|
|
approved - Boolean
|
|
approvalMethod - ApprovalMethodEnum!
|
|
status - EstimateStatusEnum
|
|
clientId - ID
|
|
otherApproverName - String
|
|
signature - String
|
Example
{
"estimateId": 4,
"approved": false,
"approvalMethod": "DIGITAL_SIGNATURE",
"status": "OPEN",
"clientId": 4,
"otherApproverName": "xyz789",
"signature": "abc123"
}
EstimateCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
creatorUid - ID!
|
|
items - [EstimateItemCreateSchema!]!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
clientId - ID
|
|
isRange - Boolean
|
|
isTaxExempt - Boolean
|
|
minSubtotal - Int
|
|
maxSubtotal - Int
|
|
minTax - Int
|
|
maxTax - Int
|
|
minPstTax - Int
|
|
maxPstTax - Int
|
|
clientTaxRate - Decimal
|
|
taxRateSource - TaxRateSourceEnum
|
|
fees - Int
|
|
serviceFee - Int
|
|
discount - Int
|
|
minTotal - Int
|
|
maxTotal - Int
|
|
title - String
|
|
expirationDate - datetime
|
Example
{
"patientId": 4,
"creatorUid": "4",
"items": [EstimateItemCreateSchema],
"soapId": 4,
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"clientId": 4,
"isRange": false,
"isTaxExempt": false,
"minSubtotal": 123,
"maxSubtotal": 987,
"minTax": 987,
"maxTax": 987,
"minPstTax": 123,
"maxPstTax": 987,
"clientTaxRate": Decimal,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 123,
"discount": 123,
"minTotal": 987,
"maxTotal": 987,
"title": "xyz789",
"expirationDate": datetime
}
EstimateDeclineSchema
Fields
| Input Field | Description |
|---|---|
estimateId - ID!
|
|
status - EstimateStatusEnum
|
Example
{"estimateId": "4", "status": "OPEN"}
EstimateDeleteSchema
Fields
| Input Field | Description |
|---|---|
estimateId - ID!
|
|
status - EstimateStatusEnum
|
Example
{"estimateId": "4", "status": "OPEN"}
EstimateItemCreateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID
|
|
instanceId - ID
|
|
name - String
|
|
unit - String
|
|
pricePerUnit - Int
|
|
adminFee - Int
|
|
minimumCharge - Int
|
|
declined - Boolean
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
customPrice - Int
|
|
discountRates - [DiscountRateCreateSchema!]
|
|
labId - ID
|
|
xrayId - ID
|
|
priceType - PriceTypeEnum
|
|
markupFactor - Decimal
|
|
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
|
inventoryLatestCostPerUnit - Int
|
|
groupDiscount - ItemGroupDiscountCreateSchema
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
clinicCostPerUnit - Int
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
|
inventoryLotId - String
|
|
inventoryManufacturer - String
|
|
parentBundleInfo - ParentBundleInfoCreateSchema
|
|
hideItem - Boolean
|
|
providerId - ID
|
|
minQty - Decimal
|
|
maxQty - Decimal
|
|
minPricePerUnit - Int!
|
|
maxPricePerUnit - Int
|
|
minPrice - Int
|
|
maxPrice - Int
|
|
minSubtotal - Int
|
|
maxSubtotal - Int
|
|
minTax - Int
|
|
minPstTax - Int
|
|
maxTax - Int
|
|
maxPstTax - Int
|
|
minHasDiscount - Boolean
|
|
maxHasDiscount - Boolean
|
|
customPriceMax - Int
|
|
isDiscountable - Boolean
|
Example
{
"treatmentId": 4,
"instanceId": 4,
"name": "abc123",
"unit": "abc123",
"pricePerUnit": 987,
"adminFee": 123,
"minimumCharge": 123,
"declined": true,
"isTaxable": false,
"isPstTaxable": true,
"instructions": "xyz789",
"customPrice": 123,
"discountRates": [DiscountRateCreateSchema],
"labId": "4",
"xrayId": 4,
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": true,
"useHistoricalHigh": false,
"nonBillable": false,
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 987,
"groupDiscount": ItemGroupDiscountCreateSchema,
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 123,
"useVendorCost": true,
"vendorListPrice": 987,
"inventoryLotId": "xyz789",
"inventoryManufacturer": "abc123",
"parentBundleInfo": ParentBundleInfoCreateSchema,
"hideItem": false,
"providerId": 4,
"minQty": Decimal,
"maxQty": Decimal,
"minPricePerUnit": 123,
"maxPricePerUnit": 987,
"minPrice": 123,
"maxPrice": 987,
"minSubtotal": 123,
"maxSubtotal": 123,
"minTax": 987,
"minPstTax": 987,
"maxTax": 987,
"maxPstTax": 987,
"minHasDiscount": true,
"maxHasDiscount": true,
"customPriceMax": 123,
"isDiscountable": false
}
EstimateItemSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema
|
|
treatmentId - ID
|
|
instanceId - ID!
|
|
name - String!
|
|
unit - UnitEnum!
|
|
pricePerUnit - Int!
|
|
adminFee - Int!
|
|
minimumCharge - Int!
|
|
isTaxable - Boolean!
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
customPrice - Int
|
Custom price override for this item |
discountRates - [DiscountRateSchema!]
|
Discount rates applicable to this item |
labId - ID
|
Reference to associated lab record |
vaccineId - ID
|
Reference to associated vaccine record (Vaccine model) |
priceType - PriceTypeEnum
|
Price calculation type for this item |
markupFactor - Decimal
|
Markup factor for price calculation |
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
Historical high cost per unit for inventory |
inventoryLatestCostPerUnit - Int
|
Latest cost per unit for inventory |
groupDiscount - ItemGroupDiscountSchema
|
Group discount applied to this item |
isCustomTreatment - Boolean
|
Whether this is a custom treatment |
customTreatmentIsRxScript - Boolean
|
Whether custom treatment is an RX script |
clinicCostPerUnit - Int
|
Clinic cost per unit |
useVendorCost - Boolean
|
Whether to use vendor cost for pricing |
vendorListPrice - Int
|
Vendor list price |
inventoryLotId - String
|
Inventory lot ID |
inventoryManufacturer - String
|
Inventory manufacturer |
parentBundleInfo - ParentBundleInfoSchema
|
Information about the parent bundle if this item is part of a bundle |
hideItem - Boolean
|
Whether to hide the item from estimates and invoices pdf exports |
providerId - ID
|
|
xrayId - ID
|
|
isDiscountable - Boolean
|
|
declined - Boolean
|
Whether this item has been declined by the client during estimate approval. Used to track client preferences and exclude declined items from final calculations. |
minQty - Decimal
|
Minimum quantity for this estimate item in range-based estimates. Works with max_qty to provide quantity flexibility in cost estimates. |
maxQty - Decimal
|
Maximum quantity for this estimate item in range-based estimates. Works with min_qty to provide quantity flexibility in cost estimates. |
minPricePerUnit - Int
|
Minimum price per unit in cents for range-based pricing. Stored as integer cents to avoid floating point precision issues. |
maxPricePerUnit - Int
|
Maximum price per unit in cents for range-based pricing. Stored as integer cents to avoid floating point precision issues. |
minPrice - Int
|
Minimum total price for this item in cents (min_qty * min_price_per_unit). Calculated automatically during estimate processing. |
maxPrice - Int
|
Maximum total price for this item in cents (max_qty * max_price_per_unit). Calculated automatically during estimate processing. |
minSubtotal - Int
|
Minimum subtotal including fees but before tax in cents. Automatically calculated by EstimateCostProcessor during estimate creation/updates. |
maxSubtotal - Int
|
Maximum subtotal including fees but before tax in cents. Automatically calculated by EstimateCostProcessor during estimate creation/updates. |
minTax - Int
|
Minimum tax amount in cents based on min_subtotal and clinic tax rates. Automatically calculated by EstimateCostProcessor if item is_taxable is True. |
maxTax - Int
|
Maximum tax amount in cents based on max_subtotal and clinic tax rates. Automatically calculated by EstimateCostProcessor if item is_taxable is True. |
minPstTax - Int
|
Minimum PST tax amount in cents for jurisdictions with separate PST. Automatically calculated by EstimateCostProcessor if item is_pst_taxable is True. |
maxPstTax - Int
|
Maximum PST tax amount in cents for jurisdictions with separate PST. Automatically calculated by EstimateCostProcessor if item is_pst_taxable is True. |
minHasDiscount - Boolean
|
Whether discount is applied to the minimum price calculation. Reflects discount application status for range-based estimates. |
maxHasDiscount - Boolean
|
Whether discount is applied to the maximum price calculation. Reflects discount application status for range-based estimates. |
customPriceMax - Int
|
Custom maximum price override in cents set by staff. Allows manual adjustment of the maximum price beyond calculated values. |
Example
{
"treatment": TreatmentSchema,
"treatmentId": 4,
"instanceId": 4,
"name": "xyz789",
"unit": "ML",
"pricePerUnit": 123,
"adminFee": 987,
"minimumCharge": 987,
"isTaxable": true,
"isPstTaxable": false,
"instructions": "abc123",
"customPrice": 123,
"discountRates": [DiscountRateSchema],
"labId": "4",
"vaccineId": 4,
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": true,
"useHistoricalHigh": false,
"nonBillable": true,
"inventoryHistoricalHighCostPerUnit": 123,
"inventoryLatestCostPerUnit": 123,
"groupDiscount": ItemGroupDiscountSchema,
"isCustomTreatment": false,
"customTreatmentIsRxScript": false,
"clinicCostPerUnit": 987,
"useVendorCost": true,
"vendorListPrice": 987,
"inventoryLotId": "abc123",
"inventoryManufacturer": "xyz789",
"parentBundleInfo": ParentBundleInfoSchema,
"hideItem": true,
"providerId": "4",
"xrayId": "4",
"isDiscountable": false,
"declined": true,
"minQty": Decimal,
"maxQty": Decimal,
"minPricePerUnit": 987,
"maxPricePerUnit": 123,
"minPrice": 987,
"maxPrice": 987,
"minSubtotal": 123,
"maxSubtotal": 987,
"minTax": 987,
"maxTax": 987,
"minPstTax": 987,
"maxPstTax": 987,
"minHasDiscount": true,
"maxHasDiscount": true,
"customPriceMax": 123
}
EstimateItemUpdateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID
|
|
instanceId - ID
|
|
name - String
|
|
unit - String
|
|
adminFee - Int
|
|
minimumCharge - Int
|
|
pricePerUnit - Int
|
|
declined - Boolean
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
cost - Int
|
|
customPrice - Int
|
|
hasDiscount - Boolean
|
|
discountRates - [DiscountRateCreateSchema!]
|
|
labId - ID
|
|
xrayId - ID
|
|
vaccineId - ID
|
|
priceType - PriceTypeEnum
|
|
markupFactor - Decimal
|
|
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
|
inventoryLatestCostPerUnit - Int
|
|
groupDiscount - ItemGroupDiscountCreateSchema
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
clinicCostPerUnit - Int
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
|
inventoryLotId - String
|
|
inventoryManufacturer - String
|
|
parentBundleInfo - ParentBundleInfoCreateSchema
|
|
hideItem - Boolean
|
|
providerId - ID
|
|
minQty - Decimal
|
|
maxQty - Decimal
|
|
minPricePerUnit - Int
|
|
maxPricePerUnit - Int
|
|
minPrice - Int
|
|
maxPrice - Int
|
|
minSubtotal - Int
|
|
maxSubtotal - Int
|
|
minTax - Int
|
|
minPstTax - Int
|
|
maxTax - Int
|
|
maxPstTax - Int
|
|
minHasDiscount - Boolean
|
|
maxHasDiscount - Boolean
|
|
customPriceMax - Int
|
|
isDiscountable - Boolean
|
Example
{
"treatmentId": "4",
"instanceId": 4,
"name": "abc123",
"unit": "abc123",
"adminFee": 987,
"minimumCharge": 123,
"pricePerUnit": 123,
"declined": false,
"isTaxable": false,
"isPstTaxable": false,
"instructions": "abc123",
"cost": 987,
"customPrice": 123,
"hasDiscount": false,
"discountRates": [DiscountRateCreateSchema],
"labId": "4",
"xrayId": 4,
"vaccineId": "4",
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": true,
"useHistoricalHigh": false,
"nonBillable": true,
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 123,
"groupDiscount": ItemGroupDiscountCreateSchema,
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 123,
"useVendorCost": true,
"vendorListPrice": 123,
"inventoryLotId": "abc123",
"inventoryManufacturer": "xyz789",
"parentBundleInfo": ParentBundleInfoCreateSchema,
"hideItem": true,
"providerId": "4",
"minQty": Decimal,
"maxQty": Decimal,
"minPricePerUnit": 123,
"maxPricePerUnit": 987,
"minPrice": 123,
"maxPrice": 123,
"minSubtotal": 987,
"maxSubtotal": 987,
"minTax": 123,
"minPstTax": 987,
"maxTax": 123,
"maxPstTax": 123,
"minHasDiscount": false,
"maxHasDiscount": false,
"customPriceMax": 123,
"isDiscountable": true
}
EstimateSchema
Fields
| Field Name | Description |
|---|---|
soap - SoapSchema
|
|
estimateId - ID!
|
|
status - EstimateStatusEnum!
|
Current status of the estimate affecting what operations are allowed. OPEN: can be modified/approved/deleted; LOCKED: approved and immutable; DELETED: soft-deleted. Status changes trigger patient history updates (PatientHistoryService). |
patientId - ID!
|
Reference to the patient this estimate is for (Patient model). Required field used for estimate filtering and patient history tracking. Validates patient exists in clinic during estimate creation. |
creatorUid - ID!
|
Reference to the clinic user who created this estimate (ClinicUser model). Must be an ACTIVE user at time of creation, validated in EstimateService. Used for audit trails and permissions. |
soapId - ID
|
Optional reference to associated SOAP note (Soap model). Links estimate to specific medical consultation notes. Part of note_type_mapping system for estimate-note relationships. |
surgeryId - ID
|
Optional reference to associated surgery record (Surgery model). Links estimate to surgical procedure documentation. Part of note_type_mapping system for estimate-note relationships. |
visitNoteId - ID
|
Optional reference to associated visit note (VisitNote model). Links estimate to general visit documentation. Part of note_type_mapping system for estimate-note relationships. |
orderNoteId - ID
|
Optional reference to associated order note (OrderNote model). Links estimate to treatment order documentation. Part of note_type_mapping system for estimate-note relationships. |
items - [EstimateItemSchema!]
|
List of estimate items with pricing details and treatment information. Each item inherits from CommonInvoiceItem and adds range-based pricing. Required field - estimates must have at least one item. |
isRange - Boolean
|
Whether this estimate uses range-based pricing (min/max values). Affects how pricing calculations and display are handled. When True, shows price ranges; when False, shows single prices. |
minSubtotal - Int
|
Minimum subtotal across all items in cents before tax. Automatically calculated by EstimateCostProcessor from item minimums. |
maxSubtotal - Int
|
Maximum subtotal across all items in cents before tax. Automatically calculated by EstimateCostProcessor from item maximums. |
isTaxExempt - Boolean
|
Whether this estimate is exempt from tax calculations. When True, all tax fields remain zero regardless of item taxability. |
minTax - Int
|
Minimum total tax amount in cents. Automatically calculated by EstimateCostProcessor from clinic tax rates and min_subtotal. |
maxTax - Int
|
Maximum total tax amount in cents. Automatically calculated by EstimateCostProcessor from clinic tax rates and max_subtotal. |
minPstTax - Int
|
Minimum PST tax amount in cents for jurisdictions with separate PST. Automatically calculated when clinic has pst_tax_rate configured. |
maxPstTax - Int
|
Maximum PST tax amount in cents for jurisdictions with separate PST. Automatically calculated when clinic has pst_tax_rate configured. |
taxRate - Float
|
Tax rate percentage used for this estimate (copied from clinic settings). Stored as decimal (e.g., 0.13 for 13% tax) for calculation transparency. |
pstTaxRate - Float
|
PST tax rate percentage used for this estimate (copied from clinic settings). Stored as decimal (e.g., 0.07 for 7% PST) for calculation transparency. |
clientTaxRate - Float
|
Client-specific tax rate based on their location. Used for location-based tax calculations. |
taxRateSource - TaxRateSourceEnum
|
Source of the tax rate (CLINIC or CLIENT_LOCATION). Indicates whether tax rate comes from clinic settings or client location. |
fees - Int
|
Additional fees in cents applied to the estimate. Added to subtotal before tax calculations. |
serviceFee - Int
|
Service fee amount calculated as a percentage of subtotal from settings. Stored as integer cents. Automatically calculated during cost processing. |
discount - Int
|
Total discount amount in cents applied to the estimate. Requires special permission (can_create_discount) to set non-zero values. |
minTotal - Int
|
Minimum final total in cents including all taxes, fees, service fee, and discounts. Automatically calculated as min_subtotal + fees + service_fee - discount + min_tax + min_pst_tax. |
maxTotal - Int
|
Maximum final total in cents including all taxes, fees, service fee, and discounts. Automatically calculated as max_subtotal + fees + service_fee - discount + max_tax + max_pst_tax. |
approved - Boolean
|
Whether this estimate has been approved by the client. Set to True during approval process, triggers status change to LOCKED. Once approved, estimate becomes immutable. |
approvalMethod - ApprovalMethodEnum
|
Method used to obtain client approval for this estimate. Required when approved is True, determines approval workflow validation. |
signature - String
|
Base64 encoded image of client signature for digital approval. Used when approval_method is DIGITAL_SIGNATURE. |
clientId - ID
|
Reference to the client who approved this estimate (ClinicUser model). May differ from patient_id if someone else is responsible for payment. |
otherApproverName - String
|
Name of person who approved estimate when not a registered client. Used for non-digital approval methods to record approver identity. |
media - [MediaSchema!]
|
Associated media files like images or documents (Media model). Populated by MediaService.read_mediums() with status DONE. Not stored directly but loaded from separate media collection. |
title - String
|
Human-readable title or description for this estimate. Optional field for better estimate identification and organization. |
expirationDate - datetime
|
Date when this estimate expires and is no longer valid. Used for estimate management and client communication. |
createdAt - datetime
|
|
updatedAt - datetime
|
Example
{
"soap": SoapSchema,
"estimateId": "4",
"status": "OPEN",
"patientId": 4,
"creatorUid": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": "4",
"items": [EstimateItemSchema],
"isRange": false,
"minSubtotal": 987,
"maxSubtotal": 123,
"isTaxExempt": true,
"minTax": 987,
"maxTax": 123,
"minPstTax": 123,
"maxPstTax": 987,
"taxRate": 987.65,
"pstTaxRate": 123.45,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 987,
"discount": 987,
"minTotal": 123,
"maxTotal": 123,
"approved": false,
"approvalMethod": "DIGITAL_SIGNATURE",
"signature": "xyz789",
"clientId": "4",
"otherApproverName": "xyz789",
"media": [MediaSchema],
"title": "abc123",
"expirationDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
EstimateSettingsSchema
Fields
| Field Name | Description |
|---|---|
includeDisclaimerOnUnapprovedEstimates - Boolean!
|
Example
{"includeDisclaimerOnUnapprovedEstimates": true}
EstimateSettingsUpdateSchema
EstimateStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
EstimateUnlinkFromNoteSchema
Fields
| Input Field | Description |
|---|---|
estimateId - ID!
|
Example
{"estimateId": 4}
EstimateUpdateSchema
Fields
| Input Field | Description |
|---|---|
estimateId - ID!
|
|
items - [EstimateItemUpdateSchema!]
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
isRange - Boolean
|
|
isTaxExempt - Boolean
|
|
minSubtotal - Int
|
|
maxSubtotal - Int
|
|
minTax - Int
|
|
maxTax - Int
|
|
minPstTax - Int
|
|
maxPstTax - Int
|
|
clientTaxRate - Decimal
|
|
taxRateSource - TaxRateSourceEnum
|
|
fees - Int
|
|
serviceFee - Int
|
|
discount - Int
|
|
minTotal - Int
|
|
maxTotal - Int
|
|
title - String
|
|
expirationDate - datetime
|
Example
{
"estimateId": "4",
"items": [EstimateItemUpdateSchema],
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"isRange": false,
"isTaxExempt": true,
"minSubtotal": 123,
"maxSubtotal": 123,
"minTax": 987,
"maxTax": 123,
"minPstTax": 987,
"maxPstTax": 987,
"clientTaxRate": Decimal,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 987,
"minTotal": 987,
"maxTotal": 123,
"title": "xyz789",
"expirationDate": datetime
}
EstimatesByNoteIdInput
EventSchema
Fields
| Field Name | Description |
|---|---|
type - ScheduleType!
|
|
scheduleId - ID!
|
|
employeeUid - ID
|
|
creatorUid - ID
|
|
startDatetime - datetime!
|
|
endDatetime - datetime!
|
|
fullDay - Boolean
|
|
onlineBookingConfig - OnlineBookingConfigSchema
|
|
employee - PublicClinicUserSchema
|
Example
{
"type": "WORK_HOURS",
"scheduleId": "4",
"employeeUid": 4,
"creatorUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": true,
"onlineBookingConfig": OnlineBookingConfigSchema,
"employee": PublicClinicUserSchema
}
Extension
FamilyFilterSchema
Fields
| Input Field | Description |
|---|---|
familyId - ListObjectIdFilter
|
|
primaryContactUid - ListObjectIdFilter
|
|
secondaryContactUid - ListObjectIdFilter
|
|
balanceAmount - IntFilter
|
|
storeCreditBalance - IntFilter
|
|
status - StrFilter
|
|
createdAt - DateFilter
|
|
lastReminderSentAt - DateFilter
|
Example
{
"familyId": ListObjectIdFilter,
"primaryContactUid": ListObjectIdFilter,
"secondaryContactUid": ListObjectIdFilter,
"balanceAmount": IntFilter,
"storeCreditBalance": IntFilter,
"status": StrFilter,
"createdAt": DateFilter,
"lastReminderSentAt": DateFilter
}
FamilyInvoicesViewSchema
Example
{
"id": "4",
"familyId": 4,
"familyName": "xyz789",
"familyNameLowercase": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"balanceAmount": 987,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": "4",
"secondaryContactUid": 4,
"invoices": [InvoiceViewSchema]
}
FamilySchema
Fields
| Field Name | Description |
|---|---|
familyId - ID!
|
|
familyName - String!
|
The surname of the family. When updated, automatically updates the last_name of all patients in the family. |
primaryContactUid - ID
|
Reference to the primary contact client (ClinicUser model). Must be unique across families - a client cannot be the primary contact for multiple families. This client should have their client_info.family_id field set to this family's ID. |
secondaryContactUid - ID
|
Reference to an optional secondary contact client (ClinicUser model). This client should have their client_info.family_id field set to this family's ID if provided. |
clients - [ID!]
|
List of client IDs (ClinicUser model) belonging to this family. Should include at least the primary_contact_uid. All clients in this list should have their client_info.family_id field set to this family's ID. Each client should have a unique client_info.client_ext_id in the format {family_ext_id}-{index}. |
patients - [ID!]
|
List of patient IDs (ClinicPatient model) belonging to this family. All patients must have their last_name field matching the family_name. The app automatically updates patient last names when family_name changes. Each patient's family_id field should reference this family's ID. |
balanceAmount - Int
|
The family's outstanding balance in cents (not dollars). Must be consistent with the sum of all unpaid invoices minus payments for this family. CREDIT transactions (Transaction model) decrease this balance, while DEBIT transactions increase it. |
storeCreditBalance - Int
|
The family's store credit balance in cents (not dollars). Must be consistent with store credit transactions (Transaction model with method=MethodEnum.STORE_CREDIT). Store credits can be applied to reduce the family's balance_amount. |
status - FamilyStatus
|
Current status of the family account. Affects accounts receivable processes and reporting. |
familyExtId - String!
|
Incrementing unique ID assigned on creation. Must be unique across all families. Used to generate client external IDs in the format {family_ext_id}-{index}. |
createdAt - datetime
|
|
updatedAt - datetime
|
|
lastReminderSentAt - datetime
|
Timestamp when the last reminder was sent to the family. Optional field used for tracking communication history. |
Example
{
"familyId": "4",
"familyName": "xyz789",
"primaryContactUid": "4",
"secondaryContactUid": 4,
"clients": ["4"],
"patients": [4],
"balanceAmount": 987,
"storeCreditBalance": 123,
"status": "ACTIVE",
"familyExtId": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"lastReminderSentAt": datetime
}
FamilyStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
FamilyViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
familyId - ID!
|
|
familyName - String!
|
|
familyNameLowercase - String!
|
|
familyExtId - String!
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
balanceAmount - Int
|
|
storeCreditBalance - Int
|
|
status - FamilyStatus
|
|
primaryContactUid - ID
|
|
secondaryContactUid - ID
|
|
primaryContact - ClinicUserSchema
|
|
secondaryContact - ClinicUserSchema
|
|
clients - [ClinicUserSchema!]
|
|
patients - [PatientSchema!]
|
|
lastReminderSentAt - datetime
|
Example
{
"id": 4,
"familyId": "4",
"familyName": "abc123",
"familyNameLowercase": "xyz789",
"familyExtId": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"balanceAmount": 987,
"storeCreditBalance": 987,
"status": "ACTIVE",
"primaryContactUid": "4",
"secondaryContactUid": "4",
"primaryContact": ClinicUserSchema,
"secondaryContact": ClinicUserSchema,
"clients": [ClinicUserSchema],
"patients": [PatientSchema],
"lastReminderSentAt": datetime
}
FamilyViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [FamilyViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [FamilyViewSchemaEdge]
}
FamilyViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - FamilyViewSchema!
|
|
cursor - String!
|
Example
{
"node": FamilyViewSchema,
"cursor": "xyz789"
}
FeatureFlagName
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PERMISSIONS"
FeatureFlagSchema
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
nameEnum - FeatureFlagName
|
|
description - String
|
|
enabled - Boolean
|
|
enabledGlobal - Boolean
|
Example
{
"name": "xyz789",
"nameEnum": "PERMISSIONS",
"description": "xyz789",
"enabled": false,
"enabledGlobal": true
}
FeatureFlagUpdateSchema
FieldCondition
Fields
| Field Name | Description |
|---|---|
fieldPath - String!
|
|
operator - ConditionOperator!
|
|
value - String!
|
Example
{
"fieldPath": "abc123",
"operator": "EQUALS",
"value": "abc123"
}
FieldConditionInput
Fields
| Input Field | Description |
|---|---|
fieldPath - String!
|
|
operator - ConditionOperator!
|
|
value - String!
|
Example
{
"fieldPath": "abc123",
"operator": "EQUALS",
"value": "abc123"
}
FillRxScriptResponseSchema
Fields
| Field Name | Description |
|---|---|
rxScript - RxScriptSchema!
|
|
invoice - InvoiceSchema
|
Example
{
"rxScript": RxScriptSchema,
"invoice": InvoiceSchema
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FollowUpSchema
FollowUpUpdateSchema
FormCreateSchema
FormDuplicateSchema
FormFilterSchema
Fields
| Input Field | Description |
|---|---|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"createdAt": DateFilter,
"deletedAt": StrFilter
}
FormSchema
Example
{
"id": 4,
"title": "abc123",
"description": "abc123",
"uiSchema": {},
"baseSchema": {},
"creatorId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
FormSubmissionCreateSchema
Example
{
"formId": ["4"],
"clientId": 4,
"patientId": "4",
"publicId": {},
"message": "xyz789",
"appointmentId": 4,
"sentVia": ["EMAIL"],
"sentBy": "4",
"dueDate": datetime
}
FormSubmissionDataSchema
FormSubmissionSchema
Fields
| Field Name | Description |
|---|---|
url - String!
|
|
id - ID!
|
MongoDB document ObjectID |
formId - ID!
|
|
formData - JSON!
|
|
clientId - ID
|
|
patientId - ID
|
|
status - FormSubmissionStatus
|
|
publicId - String!
|
|
message - String
|
|
appointmentId - ID
|
|
sentVia - [FormSubmissionSentVia!]!
|
|
sentBy - ID
|
|
submittedAt - datetime
|
|
deletedAt - datetime
|
|
dueDate - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"url": "abc123",
"id": "4",
"formId": "4",
"formData": {},
"clientId": "4",
"patientId": "4",
"status": "SENT",
"publicId": "xyz789",
"message": "xyz789",
"appointmentId": "4",
"sentVia": ["EMAIL"],
"sentBy": 4,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
FormSubmissionSentVia
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
FormSubmissionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SENT"
FormSubmissionUpdateSchema
FormSubmissionViewFilterSchema
Fields
| Input Field | Description |
|---|---|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
|
clientId - ObjectIdFilter
|
|
patientId - ObjectIdFilter
|
|
status - StrFilter
|
|
submittedAt - DateFilter
|
|
sentBy - ObjectIdFilter
|
Example
{
"createdAt": DateFilter,
"deletedAt": StrFilter,
"clientId": ObjectIdFilter,
"patientId": ObjectIdFilter,
"status": StrFilter,
"submittedAt": DateFilter,
"sentBy": ObjectIdFilter
}
FormSubmissionViewSchema
Fields
| Field Name | Description |
|---|---|
url - String!
|
|
id - String!
|
|
formId - ID!
|
|
formData - JSON!
|
|
client - ClinicUserSchema
|
|
patient - PatientSchema
|
|
message - String
|
|
appointmentId - ID
|
|
appointment - AppointmentViewSchema
|
|
status - FormSubmissionStatus
|
|
publicId - String!
|
|
sentVia - [FormSubmissionSentVia!]!
|
|
sentByUser - ClinicUserSchema
|
|
form - FormSchema
|
|
submittedAt - datetime
|
|
deletedAt - datetime
|
|
dueDate - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"url": "xyz789",
"id": "xyz789",
"formId": "4",
"formData": {},
"client": ClinicUserSchema,
"patient": PatientSchema,
"message": "abc123",
"appointmentId": 4,
"appointment": AppointmentViewSchema,
"status": "SENT",
"publicId": "xyz789",
"sentVia": ["EMAIL"],
"sentByUser": ClinicUserSchema,
"form": FormSchema,
"submittedAt": datetime,
"deletedAt": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
FormSubmissionViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [FormSubmissionViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [FormSubmissionViewSchemaEdge]
}
FormSubmissionViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - FormSubmissionViewSchema!
|
|
cursor - String!
|
Example
{
"node": FormSubmissionViewSchema,
"cursor": "xyz789"
}
FormUpdateSchema
FormViewSchema
Example
{
"creatorId": "4",
"id": "4",
"title": "xyz789",
"description": "xyz789",
"uiSchema": {},
"baseSchema": {},
"creator": ClinicUserSchema,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
FormViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [FormViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [FormViewSchemaEdge]
}
FormViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - FormViewSchema!
|
|
cursor - String!
|
Example
{
"node": FormViewSchema,
"cursor": "xyz789"
}
FreemiumCreateSchema
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
FreemiumFilterSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
FreemiumSchema
FreemiumSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [FreemiumSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [FreemiumSchemaEdge]
}
FreemiumSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - FreemiumSchema!
|
|
cursor - String!
|
Example
{
"node": FreemiumSchema,
"cursor": "xyz789"
}
FreemiumUpdateSchema
FrequencyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"WEEKLY"
Gender
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MALE"
GenerateSoapRequest
GroupDiscountCreateSchema
GroupDiscountSchema
Example
{
"id": 4,
"name": "abc123",
"percentage": Decimal,
"creatorId": 4,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
GroupDiscountStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
GroupDiscountUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
percentage - Decimal
|
|
status - GroupDiscountStatus
|
Example
{
"id": "4",
"name": "abc123",
"percentage": Decimal,
"status": "ACTIVE"
}
GroupDiscountViewFilterSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - DateFilter
|
|
name - StrFilter
|
|
status - StrFilter
|
Example
{
"creatorId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": DateFilter,
"name": StrFilter,
"status": StrFilter
}
GroupDiscountViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
percentage - Decimal!
|
|
creator - ClinicUserSchema!
|
|
status - GroupDiscountStatus!
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "abc123",
"name": "abc123",
"percentage": Decimal,
"creator": ClinicUserSchema,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
GroupDiscountViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [GroupDiscountViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [GroupDiscountViewSchemaEdge]
}
GroupDiscountViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - GroupDiscountViewSchema!
|
|
cursor - String!
|
Example
{
"node": GroupDiscountViewSchema,
"cursor": "abc123"
}
GroupTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ATTACHMENT"
HL7ProviderSchema
Highlight
HighlightSchema
Fields
| Field Name | Description |
|---|---|
path - String
|
|
texts - [TextSchema!]
|
|
score - Float
|
Example
{
"path": "xyz789",
"texts": [TextSchema],
"score": 123.45
}
Hl7iConnectSchema
Fields
| Input Field | Description |
|---|---|
clinicId - String!
|
|
labVendor - LabVendor!
|
Example
{"clinicId": "xyz789", "labVendor": "OTHER"}
Hl7iDisconnectSchema
Fields
| Input Field | Description |
|---|---|
labVendor - LabVendor!
|
Example
{"labVendor": "OTHER"}
Hl7iOptionSchema
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
clinicId - String!
|
|
labVendor - LabVendor!
|
Example
{
"enabled": false,
"clinicId": "abc123",
"labVendor": "OTHER"
}
Hl7iOptionUpdateSchema
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
|
clinicId - String!
|
|
labVendor - LabVendor!
|
Example
{
"enabled": false,
"clinicId": "abc123",
"labVendor": "OTHER"
}
Hl7iProviderIdCreateSchema
Fields
| Input Field | Description |
|---|---|
hl7iProviderId - String!
|
|
labVendor - LabVendor!
|
Example
{
"hl7iProviderId": "xyz789",
"labVendor": "OTHER"
}
Hl7iProviderIdSchema
Fields
| Field Name | Description |
|---|---|
hl7iProviderId - String!
|
|
labVendor - LabVendor!
|
Example
{
"hl7iProviderId": "abc123",
"labVendor": "OTHER"
}
Hl7iProviderIdUpdateSchema
Fields
| Input Field | Description |
|---|---|
hl7iProviderId - String!
|
|
labVendor - LabVendor!
|
Example
{
"hl7iProviderId": "abc123",
"labVendor": "OTHER"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
IdexxSchema
Fields
| Field Name | Description |
|---|---|
idexxIdentifier - String
|
Example
{"idexxIdentifier": "abc123"}
IdexxUpdateSchema
Fields
| Input Field | Description |
|---|---|
idexxIdentifier - String
|
Example
{"idexxIdentifier": "xyz789"}
IdexxWebpacsOptionsSchema
IdexxWebpacsOptionsUpdateSchema
IncomingCallSchema
Fields
| Field Name | Description |
|---|---|
client - ClinicUserSchema
|
|
phoneNumber - String
|
Example
{
"client": ClinicUserSchema,
"phoneNumber": "abc123"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntFilter
Fields
| Input Field | Description |
|---|---|
value1 - Int!
|
|
operator - ComparisonOperators!
|
|
value2 - Int
|
Example
{"value1": 987, "operator": "EQ", "value2": 987}
InterestOptionsSchema
InterestOptionsUpdateSchema
IntraopSchema
Fields
| Field Name | Description |
|---|---|
anesthesiaStartAt - datetime
|
Timestamp when anesthesia was initiated |
anesthesiaEndAt - datetime
|
Timestamp when anesthesia was discontinued |
procedureStartAt - datetime
|
Timestamp when surgical procedure began |
procedureEndAt - datetime
|
Timestamp when surgical procedure was completed |
medicationNotes - String
|
Notes about medications administered during surgery |
procedureNotes - String
|
Detailed surgical procedure notes and observations |
Example
{
"anesthesiaStartAt": datetime,
"anesthesiaEndAt": datetime,
"procedureStartAt": datetime,
"procedureEndAt": datetime,
"medicationNotes": "abc123",
"procedureNotes": "xyz789"
}
IntraopUpdateSchema
Example
{
"anesthesiaStartAt": datetime,
"anesthesiaEndAt": datetime,
"procedureStartAt": datetime,
"procedureEndAt": datetime,
"medicationNotes": "xyz789",
"procedureNotes": "xyz789"
}
InventoriesOverviewFilterSchema
Fields
| Input Field | Description |
|---|---|
isRunningLow - BoolFilter
|
|
isExpiringSoon - BoolFilter
|
|
isControlledSubstance - BoolFilter
|
|
quantityRemaining - DecimalFilter
|
|
createdAt - DateFilter
|
|
category - StrFilter
|
|
name - StrFilter
|
Example
{
"isRunningLow": BoolFilter,
"isExpiringSoon": BoolFilter,
"isControlledSubstance": BoolFilter,
"quantityRemaining": DecimalFilter,
"createdAt": DateFilter,
"category": StrFilter,
"name": StrFilter
}
InventoriesOverviewSchema
Example
{
"id": "xyz789",
"isControlledSubstance": true,
"isRunningLow": true,
"type": "abc123",
"pricePerUnit": 123,
"unit": "ML",
"furthestExpiredAt": datetime,
"quantityRemaining": Decimal,
"remainingValue": 987,
"category": "abc123",
"name": "abc123",
"createdAt": datetime
}
InventoriesOverviewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [InventoriesOverviewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [InventoriesOverviewSchemaEdge]
}
InventoriesOverviewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - InventoriesOverviewSchema!
|
|
cursor - String!
|
Example
{
"node": InventoriesOverviewSchema,
"cursor": "xyz789"
}
InventoryItemCreateSchema
Fields
| Input Field | Description |
|---|---|
unitCost - Int
|
Cost per unit in integer cents (e.g., $12.34 stored as 1234). Auto-calculated from total_cost/quantity_received if not provided. Used for inventory valuation and transaction cost tracking. Default = null |
totalCost - Int
|
Total cost of this entire lot in integer cents. Used to calculate unit_cost when not explicitly provided. Default = null |
sku - String
|
Stock Keeping Unit - unique identifier for inventory tracking. Default = null |
uom - String
|
Unit of measure for this inventory item. NOTE: treatment has its own, this one should be removed. Default = null |
inventoryQuantities - [InventoryQuantityCreateSchema!]!
|
List of quantities available at different locations/vendors. Used to track inventory across multiple storage locations. Default = [] |
inventoryLot - InventoryLotCreateSchema
|
Lot-specific information including expiration and tracking details. Required field containing batch/lot information for this inventory item |
treatmentId - ID!
|
Reference to the treatment/product this inventory represents (Treatment model). In bitwerx this is represented through a joint table. We will never have inventory item has two treatments. has_many codes/treatments, through => code_inventory_items |
Example
{
"unitCost": 123,
"totalCost": 123,
"sku": "xyz789",
"uom": "xyz789",
"inventoryQuantities": [InventoryQuantityCreateSchema],
"inventoryLot": InventoryLotCreateSchema,
"treatmentId": 4
}
InventoryItemFilterSchema
Example
{
"deletedAt": StrFilter,
"treatmentId": ObjectIdFilter,
"unitCost": IntFilter,
"sku": StrFilter,
"inventoryLotDotLotId": StrFilter,
"inventoryLotDotManufacturer": StrFilter
}
InventoryItemFromPurchaseOrderCreateSchema
Example
{
"orderId": "4",
"isLinked": false,
"treatmentId": "4",
"quantity": Decimal,
"totalPrice": 123,
"locationId": "4",
"vetcoveItemId": 123,
"expiredAt": datetime,
"lotId": "xyz789",
"serialNo": "abc123",
"manufacturer": "abc123",
"ndcNumber": "xyz789",
"unitMeasurement": "xyz789"
}
InventoryItemSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema
|
|
id - ID!
|
MongoDB document ObjectID |
unitCost - Int
|
Cost per unit in integer cents (e.g., $12.34 stored as 1234). Auto-calculated from total_cost/quantity_received if not provided. Used for inventory valuation and transaction cost tracking |
totalCost - Int
|
Total cost of this entire lot in integer cents. Used to calculate unit_cost when not explicitly provided |
sku - String
|
Stock Keeping Unit - unique identifier for inventory tracking |
uom - String
|
Unit of measure for this inventory item. NOTE: treatment has its own, this one should be removed |
inventoryQuantities - [InventoryQuantitySchema!]!
|
List of quantities available at different locations/vendors. Used to track inventory across multiple storage locations |
inventoryLot - InventoryLotSchema!
|
Lot-specific information including expiration and tracking details. Required field containing batch/lot information for this inventory item |
treatmentId - ID
|
Reference to the treatment/product this inventory represents (Treatment model). In bitwerx this is represented through a joint table. We will never have inventory item has two treatments. has_many codes/treatments, through => code_inventory_items |
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"treatment": TreatmentSchema,
"id": 4,
"unitCost": 987,
"totalCost": 987,
"sku": "xyz789",
"uom": "xyz789",
"inventoryQuantities": [InventoryQuantitySchema],
"inventoryLot": InventoryLotSchema,
"treatmentId": 4,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
InventoryItemSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [InventoryItemSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [InventoryItemSchemaEdge]
}
InventoryItemSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - InventoryItemSchema!
|
|
cursor - String!
|
Example
{
"node": InventoryItemSchema,
"cursor": "abc123"
}
InventoryItemUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
unitCost - Int
|
|
totalCost - Int
|
|
sku - String
|
|
uom - String
|
|
inventoryQuantities - [InventoryQuantityCreateSchema!]
|
|
inventoryLot - InventoryLotCreateSchema
|
|
reason - InventoryTransactionReason
|
|
creatorId - ID
|
Example
{
"id": "4",
"unitCost": 987,
"totalCost": 123,
"sku": "abc123",
"uom": "xyz789",
"inventoryQuantities": [InventoryQuantityCreateSchema],
"inventoryLot": InventoryLotCreateSchema,
"reason": "WASTAGE",
"creatorId": "4"
}
InventoryLotCreateSchema
Fields
| Input Field | Description |
|---|---|
lotId - String
|
Unique identifier for this specific lot/batch from the manufacturer or supplier. Default = null |
manufacturer - String
|
Name of the manufacturer/company that produced this lot. Default = null |
serialNo - String
|
Serial number for this specific lot, used for tracking and recalls. Default = null |
ndcNumber - String
|
National Drug Code number - FDA identifier for drug products. Default = null |
quantityReceived - Decimal!
|
Original quantity received when this lot was first added to inventory. Used to track the initial purchase amount and calculate unit costs. Default = "0.00" |
quantityRemaining - Decimal!
|
Current quantity available in this lot after consumption. When this reaches 0, the InventoryItem is soft deleted (deleted_at is set). Must match the sum of all quantities in inventory_quantities for validation. Default = "0.00" |
expiredAt - datetime
|
Expiration date for this lot - used for FIFO/LIFO inventory usage priority. Default = null |
receivedAt - datetime
|
Date when this lot was received into inventory. Default = null |
manufacturedAt - datetime
|
Date when this lot was manufactured by the supplier. Default = null |
Example
{
"lotId": "abc123",
"manufacturer": "xyz789",
"serialNo": "xyz789",
"ndcNumber": "abc123",
"quantityReceived": Decimal,
"quantityRemaining": Decimal,
"expiredAt": datetime,
"receivedAt": datetime,
"manufacturedAt": datetime
}
InventoryLotSchema
Fields
| Field Name | Description |
|---|---|
lotId - String
|
Unique identifier for this specific lot/batch from the manufacturer or supplier |
manufacturer - String
|
Name of the manufacturer/company that produced this lot |
serialNo - String
|
Serial number for this specific lot, used for tracking and recalls |
ndcNumber - String
|
National Drug Code number - FDA identifier for drug products |
quantityReceived - Decimal!
|
Original quantity received when this lot was first added to inventory. Used to track the initial purchase amount and calculate unit costs |
quantityRemaining - Decimal!
|
Current quantity available in this lot after consumption. When this reaches 0, the InventoryItem is soft deleted (deleted_at is set). Must match the sum of all quantities in inventory_quantities for validation |
expiredAt - datetime
|
Expiration date for this lot - used for FIFO/LIFO inventory usage priority |
receivedAt - datetime
|
Date when this lot was received into inventory |
manufacturedAt - datetime
|
Date when this lot was manufactured by the supplier |
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"lotId": "xyz789",
"manufacturer": "abc123",
"serialNo": "xyz789",
"ndcNumber": "abc123",
"quantityReceived": Decimal,
"quantityRemaining": Decimal,
"expiredAt": datetime,
"receivedAt": datetime,
"manufacturedAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
InventoryOptionsSchema
Fields
| Field Name | Description |
|---|---|
inventoryUsagePriority - InventoryUsagePriority
|
Example
{"inventoryUsagePriority": "FIFO"}
InventoryOptionsUpdateSchema
Fields
| Input Field | Description |
|---|---|
inventoryUsagePriority - InventoryUsagePriority
|
Example
{"inventoryUsagePriority": "FIFO"}
InventoryQuantityCreateSchema
Fields
| Input Field | Description |
|---|---|
vendorId - ID
|
Reference to the vendor who supplied this quantity (Vendor model). Default = null |
locationId - ID
|
Reference to the physical location where this quantity is stored. In bitwerx there is a actual collection representing locations. Default = null |
quantityOnHand - Decimal!
|
Current quantity available at this specific location/vendor combination. Decremented during consumption via use_quantity() method. Default = "0.00" |
sellRatio - Decimal
|
Ratio of how many of the items are sold together in a pack. Used to calculate pricing when items are sold in bulk packages. Default = null |
Example
{
"vendorId": "4",
"locationId": "4",
"quantityOnHand": Decimal,
"sellRatio": Decimal
}
InventoryQuantitySchema
Fields
| Field Name | Description |
|---|---|
vendorId - ID
|
Reference to the vendor who supplied this quantity (Vendor model) |
locationId - ID
|
Reference to the physical location where this quantity is stored. In bitwerx there is a actual collection representing locations |
quantityOnHand - Decimal!
|
Current quantity available at this specific location/vendor combination. Decremented during consumption via use_quantity() method |
sellRatio - Decimal
|
Ratio of how many of the items are sold together in a pack. Used to calculate pricing when items are sold in bulk packages |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"vendorId": 4,
"locationId": 4,
"quantityOnHand": Decimal,
"sellRatio": Decimal,
"createdAt": datetime,
"updatedAt": datetime
}
InventoryTransactionCreateSchema
Example
{
"creatorId": "4",
"reason": "WASTAGE",
"treatmentId": "4",
"inventoryItemId": "4",
"quantity": Decimal,
"unitCost": 123,
"cost": 123,
"description": "xyz789"
}
InventoryTransactionReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"WASTAGE"
InventoryTransactionSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema!
|
|
id - ID!
|
MongoDB document ObjectID |
creatorId - ID
|
|
reason - InventoryTransactionReason!
|
|
treatmentId - ID!
|
|
inventoryItemId - ID!
|
|
invoiceId - ID
|
|
patientId - ID
|
|
clientId - ID
|
|
quantity - Decimal!
|
|
unitCost - Int
|
|
cost - Int
|
|
description - String
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"treatment": TreatmentSchema,
"id": "4",
"creatorId": 4,
"reason": "WASTAGE",
"treatmentId": 4,
"inventoryItemId": "4",
"invoiceId": "4",
"patientId": 4,
"clientId": 4,
"quantity": Decimal,
"unitCost": 123,
"cost": 123,
"description": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
InventoryTransactionUpdateSchema
Example
{
"id": "4",
"creatorId": "4",
"treatmentId": "4",
"inventoryItemId": 4,
"description": "xyz789",
"unitCost": 987,
"cost": 123,
"quantity": Decimal
}
InventoryTransactionViewFilterSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ListObjectIdFilter
|
|
treatmentId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"creatorId": ListObjectIdFilter,
"treatmentId": ListObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
InventoryTransactionViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
creator - ClinicUserSchema
|
|
invoice - InvoiceSchema
|
|
patient - PatientSchema
|
|
client - ClinicUserSchema
|
|
patientId - ID
|
|
clientId - ID
|
|
invoiceId - ID
|
|
treatment - TreatmentSchema!
|
|
inventoryItem - InventoryItemSchema!
|
|
reason - InventoryTransactionReason!
|
|
quantity - Decimal!
|
|
unitCost - Int
|
|
cost - Int
|
|
description - String
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "abc123",
"creator": ClinicUserSchema,
"invoice": InvoiceSchema,
"patient": PatientSchema,
"client": ClinicUserSchema,
"patientId": "4",
"clientId": "4",
"invoiceId": 4,
"treatment": TreatmentSchema,
"inventoryItem": InventoryItemSchema,
"reason": "WASTAGE",
"quantity": Decimal,
"unitCost": 123,
"cost": 123,
"description": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
InventoryTransactionViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [InventoryTransactionViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [InventoryTransactionViewSchemaEdge]
}
InventoryTransactionViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - InventoryTransactionViewSchema!
|
|
cursor - String!
|
Example
{
"node": InventoryTransactionViewSchema,
"cursor": "xyz789"
}
InventoryUsagePriority
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIFO"
InvoiceBillingAndPaymentResponse
Example
{
"success": true,
"message": "xyz789",
"paymentInvoiceIds": [4],
"totalPaid": 987,
"accountBalanceUsed": 987,
"creditUsed": 123,
"paymentUsed": 123
}
InvoiceBillingAndPaymentSchema
Fields
| Input Field | Description |
|---|---|
invoiceIds - [ID!]
|
|
accountBalanceAmount - Int
|
|
creditAmount - Int
|
|
paymentAmount - Int
|
|
changeAmount - Int
|
|
paymentMethod - MethodEnum
|
|
paymentMethodId - String
|
|
network - NetworkEnum
|
|
notes - String
|
|
attachCard - Boolean
|
|
applyCashDiscount - Boolean
|
|
terminalId - String
|
|
transactionCreateSchema - TransactionCreateSchema
|
Example
{
"invoiceIds": [4],
"accountBalanceAmount": 987,
"creditAmount": 123,
"paymentAmount": 123,
"changeAmount": 987,
"paymentMethod": "CASH",
"paymentMethodId": "xyz789",
"network": "PRO_BONO",
"notes": "abc123",
"attachCard": false,
"applyCashDiscount": false,
"terminalId": "abc123",
"transactionCreateSchema": TransactionCreateSchema
}
InvoiceCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
creatorUid - ID!
|
|
items - [InvoiceItemCreateSchema!]!
|
|
status - InvoiceStatusEnum
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
estimateId - ID
|
|
clientId - ID
|
|
subtotal - Int
|
|
isTaxExempt - Boolean
|
|
tax - Int
|
|
taxRate - Decimal
|
|
pstTax - Int
|
|
pstTaxRate - Decimal
|
|
clientTaxRate - Decimal
|
|
taxRateSource - TaxRateSourceEnum
|
|
fees - Int
|
|
serviceFee - Int
|
|
discount - Int
|
|
total - Int
|
|
notes - String
|
|
invoicedAt - datetime
|
|
accountBalanceApplied - Int
|
|
storeCreditApplied - Int
|
|
meta - String
|
|
title - String
|
Example
{
"patientId": 4,
"creatorUid": 4,
"items": [InvoiceItemCreateSchema],
"status": "OPEN",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": 4,
"clientId": "4",
"subtotal": 123,
"isTaxExempt": false,
"tax": 123,
"taxRate": Decimal,
"pstTax": 987,
"pstTaxRate": Decimal,
"clientTaxRate": Decimal,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 987,
"discount": 987,
"total": 123,
"notes": "abc123",
"invoicedAt": datetime,
"accountBalanceApplied": 123,
"storeCreditApplied": 987,
"meta": "xyz789",
"title": "xyz789"
}
InvoiceDeleteSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
|
status - InvoiceStatusEnum
|
Example
{"invoiceId": 4, "status": "OPEN"}
InvoiceDuplicateSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
Example
{"invoiceId": 4}
InvoiceItemCreateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID
|
|
instanceId - ID
|
|
name - String
|
|
unit - String
|
|
pricePerUnit - Int
|
|
adminFee - Int
|
|
minimumCharge - Int
|
|
declined - Boolean
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
customPrice - Int
|
|
discountRates - [DiscountRateCreateSchema!]
|
|
labId - ID
|
|
xrayId - ID
|
|
priceType - PriceTypeEnum
|
|
markupFactor - Decimal
|
|
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
|
inventoryLatestCostPerUnit - Int
|
|
groupDiscount - ItemGroupDiscountCreateSchema
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
clinicCostPerUnit - Int
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
|
inventoryLotId - String
|
|
inventoryManufacturer - String
|
|
parentBundleInfo - ParentBundleInfoCreateSchema
|
|
hideItem - Boolean
|
|
providerId - ID
|
|
providerCode - ProviderCode
|
|
qty - Decimal!
|
|
cost - Int
|
|
clinicCost - Int
|
|
discount - Int
|
|
subtotal - Int
|
|
tax - Int
|
|
pstTax - Int
|
|
hasDiscount - Boolean
|
|
dayOfService - datetime
|
|
deactivatePatientOnCheckout - Boolean
|
|
spayPatientOnCheckout - Boolean
|
|
isDiscountable - Boolean
|
Example
{
"treatmentId": 4,
"instanceId": "4",
"name": "abc123",
"unit": "xyz789",
"pricePerUnit": 123,
"adminFee": 987,
"minimumCharge": 987,
"declined": false,
"isTaxable": true,
"isPstTaxable": false,
"instructions": "xyz789",
"customPrice": 123,
"discountRates": [DiscountRateCreateSchema],
"labId": "4",
"xrayId": 4,
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": true,
"useHistoricalHigh": true,
"nonBillable": true,
"inventoryHistoricalHighCostPerUnit": 987,
"inventoryLatestCostPerUnit": 987,
"groupDiscount": ItemGroupDiscountCreateSchema,
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 123,
"useVendorCost": true,
"vendorListPrice": 987,
"inventoryLotId": "abc123",
"inventoryManufacturer": "abc123",
"parentBundleInfo": ParentBundleInfoCreateSchema,
"hideItem": false,
"providerId": "4",
"providerCode": "ER",
"qty": Decimal,
"cost": 123,
"clinicCost": 123,
"discount": 123,
"subtotal": 987,
"tax": 987,
"pstTax": 123,
"hasDiscount": true,
"dayOfService": datetime,
"deactivatePatientOnCheckout": true,
"spayPatientOnCheckout": false,
"isDiscountable": true
}
InvoiceItemSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema
|
|
treatmentId - ID
|
|
instanceId - ID!
|
|
name - String!
|
|
unit - UnitEnum!
|
|
pricePerUnit - Int!
|
|
adminFee - Int!
|
|
minimumCharge - Int!
|
|
isTaxable - Boolean!
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
customPrice - Int
|
Custom price override for this item |
discountRates - [DiscountRateSchema!]
|
Discount rates applicable to this item |
labId - ID
|
Reference to associated lab record |
vaccineId - ID
|
Reference to associated vaccine record (Vaccine model) |
priceType - PriceTypeEnum
|
Price calculation type for this item |
markupFactor - Decimal
|
Markup factor for price calculation |
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
Historical high cost per unit for inventory |
inventoryLatestCostPerUnit - Int
|
Latest cost per unit for inventory |
groupDiscount - ItemGroupDiscountSchema
|
Group discount applied to this item |
isCustomTreatment - Boolean
|
Whether this is a custom treatment |
customTreatmentIsRxScript - Boolean
|
Whether custom treatment is an RX script |
clinicCostPerUnit - Int
|
Clinic cost per unit |
useVendorCost - Boolean
|
Whether to use vendor cost for pricing |
vendorListPrice - Int
|
Vendor list price |
inventoryLotId - String
|
Inventory lot ID |
inventoryManufacturer - String
|
Inventory manufacturer |
parentBundleInfo - ParentBundleInfoSchema
|
Information about the parent bundle if this item is part of a bundle |
hideItem - Boolean
|
Whether to hide the item from estimates and invoices pdf exports |
providerId - ID
|
The provider who performed the service or prescribed the item (References ClinicUser model). Logically required for commission calculations, but can be null in the database. |
providerCode - ProviderCode
|
Provider's code/identifier used for reporting and commission calculations. Set automatically when provider_id is set. |
qty - Decimal!
|
Quantity of the item/service - stored as Decimal to handle fractional quantities. Required field - cannot be null. |
hasDiscount - Boolean
|
Indicates if a discount has been applied to this specific line item. Used for UI display and discount calculations. |
dayOfService - datetime
|
The date when the service was actually performed. May differ from invoice creation date for recurring or scheduled services. Used for reporting and revenue recognition. Optional but important for accurate financial reporting. |
cost - Int
|
The price charged to the customer for this item. Stored as integer cents (e.g., $10.00 = 1000). Typed as optional but typically set during cost processing. |
clinicCost - Int
|
The actual cost to the clinic for this item (COGS). Used for profit margin calculations and inventory valuation. Stored as integer cents. Set automatically when consuming inventory items during invoice locking. |
discount - Int
|
Discount amount applied to this specific line item. Stored as integer cents. Optional but must be 0 or positive if set. |
subtotal - Int
|
Line item subtotal (qty * cost - discount). Stored as integer cents. Typed as optional but calculated and set during cost processing. Logically required for financial calculations. |
tax - Int
|
Tax amount for this line item. Calculated based on tax_rate and subtotal if item is taxable. Stored as integer cents. Typed as optional but calculated and set during cost processing. |
pstTax - Int
|
Provincial/State Sales Tax amount (for regions with multiple tax types). Calculated based on pst_tax_rate and subtotal if item is pst_taxable. Stored as integer cents. Optional, only used in regions with separate PST. |
deactivatePatientOnCheckout - Boolean
|
When true, patient will be marked as inactive upon invoice checkout. Used for euthanasia or transfer services. Triggers patient status update when invoice is locked. |
spayPatientOnCheckout - Boolean
|
When true, patient will be marked as spayed/neutered upon invoice checkout. Used for spay/neuter procedures. Triggers patient status update when invoice is locked via PatientService.spay_patient. |
refunded - Boolean
|
Indicates if this item has been fully refunded. Set to True when voided_amount equals the full item amount. Used to prevent multiple refunds of the same item. |
voidedAmount - Int
|
Running total of how much of this item has been voided/refunded. Incremented during partial refunds until it equals full item amount. Stored as integer cents. Used to track partial refunds and prevent over-refunding. |
isDiscountable - Boolean
|
Indicates if this item is eligible for group discounts. None for backward compatibility with existing items, True/False for explicit control. When None, falls back to treatment's is_discountable value. |
Example
{
"treatment": TreatmentSchema,
"treatmentId": "4",
"instanceId": "4",
"name": "xyz789",
"unit": "ML",
"pricePerUnit": 123,
"adminFee": 987,
"minimumCharge": 987,
"isTaxable": true,
"isPstTaxable": true,
"instructions": "xyz789",
"customPrice": 987,
"discountRates": [DiscountRateSchema],
"labId": "4",
"vaccineId": "4",
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": false,
"useHistoricalHigh": true,
"nonBillable": true,
"inventoryHistoricalHighCostPerUnit": 123,
"inventoryLatestCostPerUnit": 123,
"groupDiscount": ItemGroupDiscountSchema,
"isCustomTreatment": true,
"customTreatmentIsRxScript": false,
"clinicCostPerUnit": 123,
"useVendorCost": false,
"vendorListPrice": 987,
"inventoryLotId": "xyz789",
"inventoryManufacturer": "xyz789",
"parentBundleInfo": ParentBundleInfoSchema,
"hideItem": true,
"providerId": 4,
"providerCode": "ER",
"qty": Decimal,
"hasDiscount": true,
"dayOfService": datetime,
"cost": 123,
"clinicCost": 123,
"discount": 987,
"subtotal": 987,
"tax": 987,
"pstTax": 987,
"deactivatePatientOnCheckout": false,
"spayPatientOnCheckout": false,
"refunded": true,
"voidedAmount": 123,
"isDiscountable": true
}
InvoiceItemUpdateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID
|
|
instanceId - ID
|
|
name - String
|
|
unit - String
|
|
adminFee - Int
|
|
minimumCharge - Int
|
|
pricePerUnit - Int
|
|
declined - Boolean
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
instructions - String
|
|
cost - Int
|
|
customPrice - Int
|
|
hasDiscount - Boolean
|
|
discountRates - [DiscountRateCreateSchema!]
|
|
labId - ID
|
|
xrayId - ID
|
|
vaccineId - ID
|
|
priceType - PriceTypeEnum
|
|
markupFactor - Decimal
|
|
inventoryEnabled - Boolean
|
|
useHistoricalHigh - Boolean
|
|
nonBillable - Boolean
|
|
inventoryHistoricalHighCostPerUnit - Int
|
|
inventoryLatestCostPerUnit - Int
|
|
groupDiscount - ItemGroupDiscountCreateSchema
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
clinicCostPerUnit - Int
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
|
inventoryLotId - String
|
|
inventoryManufacturer - String
|
|
parentBundleInfo - ParentBundleInfoCreateSchema
|
|
hideItem - Boolean
|
|
providerId - ID
|
|
providerCode - ProviderCode
|
|
qty - Decimal!
|
|
clinicCost - Int
|
|
discount - Int
|
|
subtotal - Int
|
|
tax - Int
|
|
pstTax - Int
|
|
dayOfService - datetime
|
|
deactivatePatientOnCheckout - Boolean
|
|
spayPatientOnCheckout - Boolean
|
|
refunded - Boolean
|
|
voidedAmount - Int
|
|
isDiscountable - Boolean
|
Example
{
"treatmentId": "4",
"instanceId": 4,
"name": "abc123",
"unit": "xyz789",
"adminFee": 123,
"minimumCharge": 987,
"pricePerUnit": 987,
"declined": false,
"isTaxable": true,
"isPstTaxable": true,
"instructions": "xyz789",
"cost": 987,
"customPrice": 123,
"hasDiscount": false,
"discountRates": [DiscountRateCreateSchema],
"labId": 4,
"xrayId": "4",
"vaccineId": 4,
"priceType": "FIXED",
"markupFactor": Decimal,
"inventoryEnabled": false,
"useHistoricalHigh": false,
"nonBillable": false,
"inventoryHistoricalHighCostPerUnit": 123,
"inventoryLatestCostPerUnit": 123,
"groupDiscount": ItemGroupDiscountCreateSchema,
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 987,
"useVendorCost": false,
"vendorListPrice": 987,
"inventoryLotId": "xyz789",
"inventoryManufacturer": "xyz789",
"parentBundleInfo": ParentBundleInfoCreateSchema,
"hideItem": false,
"providerId": "4",
"providerCode": "ER",
"qty": Decimal,
"clinicCost": 987,
"discount": 123,
"subtotal": 123,
"tax": 123,
"pstTax": 123,
"dayOfService": datetime,
"deactivatePatientOnCheckout": true,
"spayPatientOnCheckout": true,
"refunded": false,
"voidedAmount": 987,
"isDiscountable": false
}
InvoiceLockAndPaySchema
Fields
| Input Field | Description |
|---|---|
invoice - InvoiceLockSchema!
|
|
transaction - TransactionCreateSchema!
|
Example
{
"invoice": InvoiceLockSchema,
"transaction": TransactionCreateSchema
}
InvoiceLockSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
|
status - InvoiceStatusEnum
|
|
invoicedAt - datetime
|
Example
{
"invoiceId": "4",
"status": "OPEN",
"invoicedAt": datetime
}
InvoicePaymentStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PAID"
InvoiceRefundItemSchema
Example
{
"invoiceId": 4,
"treatmentId": "4",
"instanceId": "4",
"isManualPartialRefund": true,
"method": "CASH",
"amount": 123,
"reason": "abc123"
}
InvoiceSchema
Fields
| Field Name | Description |
|---|---|
invoiceId - ID!
|
Primary identifier for the invoice, used in all references. Automatically set to the same value as the MongoDB _id field after creation. Typed as optional but always set after invoice creation. |
patientId - ID
|
Reference to the patient this invoice is for (ClinicPatient model). Logically required for regular invoices but null for interest charge invoices. When set, triggers patient history item creation and updates patient invoice dates. Invoices created for Interest Charge are only associated with a Client. |
status - InvoiceStatusEnum
|
Current state of the invoice in its lifecycle. OPEN: Being edited, not finalized. LOCKED: Finalized, charges applied, no further edits allowed. DELETED: Soft-deleted, not visible in normal operations. |
clientId - ID
|
Reference to the client responsible for payment (ClinicUser model). Typed as optional but logically required for all invoices. Validated during create_invoice and update_invoice operations. Used for creating transactions and determining family_id. |
creatorUid - ID
|
Reference to the user who created the invoice (ClinicUser model). Typed as optional but logically required for all invoices. Validated during create_invoice operation to ensure user is active. |
voidedUid - ID
|
Reference to the user who voided the invoice (ClinicUser model). Only set when an invoice is voided. Required for void operations but null for non-voided invoices. |
soapId - ID
|
Reference to SOAP note (SOAP model). Only one of the clinical record references should be set for a given invoice. Each links this invoice to the originating clinical record. |
surgeryId - ID
|
Reference to Surgery (Surgery model). Only one of the clinical record references should be set for a given invoice. |
visitNoteId - ID
|
Reference to Visit Note (VisitNote model). Only one of the clinical record references should be set for a given invoice. |
orderNoteId - ID
|
Reference to Order Note (OrderNote model). Only one of the clinical record references should be set for a given invoice. |
estimateId - ID
|
Reference to the estimate this invoice was generated from (Estimate model). When set, indicates this invoice was created by converting an estimate. |
parentInvoiceId - ID
|
|
items - [InvoiceItemSchema!]
|
|
subtotal - Int
|
|
isTaxExempt - Boolean
|
|
tax - Int
|
|
taxRate - Float
|
|
pstTax - Int
|
|
pstTaxRate - Float
|
|
clientTaxRate - Float
|
|
taxRateSource - TaxRateSourceEnum
|
|
fees - Int
|
|
serviceFee - Int
|
Service fee amount calculated as a percentage of subtotal from settings. Stored as integer cents. Automatically calculated during cost processing. |
discount - Int
|
Invoice-level discount amount. Stored as integer cents. Required field but may be zero. Note: Being phased out in favor of line item discounts. Special permission required to add non-zero discount. |
total - Int
|
Final total amount (subtotal + tax + fees + service_fee - discount). Stored as integer cents. This is the amount the client is responsible for paying. Required field - calculated during cost processing. |
accountBalanceApplied - Int
|
Amount of client's account balance applied to this invoice. Reduces the amount client needs to pay at time of checkout. Stored as integer cents. Validated during invoice locking to ensure sufficient family balance. Creates a transaction when invoice is locked. |
accountBalanceManuallySet - Boolean
|
When true, account_balance_applied was manually set by user. When false, it was automatically calculated. |
storeCreditApplied - Int
|
Amount of client's store credit applied to this invoice. Reduces the amount client needs to pay at time of checkout. Stored as integer cents. Validated during invoice locking to ensure sufficient family store credit. Creates a transaction when invoice is locked. |
storeCreditManuallySet - Boolean
|
When true, store_credit_applied was manually set by user. When false, it was automatically calculated. |
voidedAt - datetime
|
Timestamp when invoice was voided. Null for non-voided invoices. When set, payment_status will be VOIDED. Set during void_invoice operation. |
notes - String
|
Free-text notes about the invoice. Visible to staff and potentially clients. Used as transaction notes for interest charge invoices. |
invoicedAt - datetime
|
Timestamp when invoice was locked/finalized. Set during the lock_invoice operation. Triggers financial transactions and inventory updates. Null for invoices that haven't been locked yet. |
title - String
|
Optional title/description for the invoice. Used for display purposes. |
isInterestCharge - Boolean
|
When true, this invoice represents an interest charge. Special behavior: no patient_id required, different transaction handling. |
isMigrated - Boolean
|
When true, this invoice was imported from another system. |
createdAt - datetime
|
|
updatedAt - datetime
|
|
totalPaid - Int
|
Total amount paid toward this invoice. Sum of all CREDIT transactions with ref_type TRANSACTION. Stored as integer cents. Updated automatically when payments are made or voided. |
totalInvoiceVoid - Int
|
Total amount voided from this invoice. Sum of all CREDIT transactions with ref_type INVOICE. Stored as integer cents. Updated automatically when invoice items are refunded. |
totalPaymentCancelled - Int
|
Total amount of cancelled payments. Sum of all transactions with non-null voided_transaction_id. Stored as integer cents. Updated automatically when payments are voided. |
outstandingBalance - Int
|
Remaining balance to be paid (total - total_paid + total_payment_cancelled - total_invoice_void). Stored as integer cents. Used to determine payment_status. Updated automatically when payments or refunds occur. |
paymentStatus - InvoicePaymentStatusEnum
|
|
shortInvoiceId - String
|
Last 6 characters of invoice_id. Used for easier reference in UI and communications. Set automatically during invoice creation. |
Example
{
"invoiceId": 4,
"patientId": 4,
"status": "OPEN",
"clientId": 4,
"creatorUid": "4",
"voidedUid": 4,
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"orderNoteId": 4,
"estimateId": 4,
"parentInvoiceId": 4,
"items": [InvoiceItemSchema],
"subtotal": 987,
"isTaxExempt": true,
"tax": 123,
"taxRate": 987.65,
"pstTax": 123,
"pstTaxRate": 987.65,
"clientTaxRate": 123.45,
"taxRateSource": "CLINIC",
"fees": 123,
"serviceFee": 987,
"discount": 123,
"total": 123,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": true,
"storeCreditApplied": 987,
"storeCreditManuallySet": true,
"voidedAt": datetime,
"notes": "abc123",
"invoicedAt": datetime,
"title": "abc123",
"isInterestCharge": false,
"isMigrated": true,
"createdAt": datetime,
"updatedAt": datetime,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 987,
"paymentStatus": "PAID",
"shortInvoiceId": "xyz789"
}
InvoiceSettingsSchema
Example
{
"includeRemindersOnInvoice": true,
"includeFollowUpAppointmentsOnInvoice": false,
"includeWrittenRxOnInvoice": false,
"serviceFeePercentage": Decimal,
"includeOnlyPaidOrPartialPaidInvoicesInReport": false
}
InvoiceSettingsUpdateSchema
Example
{
"includeRemindersOnInvoice": false,
"includeFollowUpAppointmentsOnInvoice": true,
"includeWrittenRxOnInvoice": true,
"includeOnlyPaidOrPartialPaidInvoicesInReport": false,
"serviceFeePercentage": Decimal
}
InvoiceStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
InvoiceUnlockSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
Example
{"invoiceId": 4}
InvoiceUpdateSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
|
clientId - ID!
|
|
items - [InvoiceItemUpdateSchema!]
|
|
subtotal - Int
|
|
isTaxExempt - Boolean
|
|
tax - Int
|
|
taxRate - Decimal
|
|
pstTax - Int
|
|
pstTaxRate - Decimal
|
|
fees - Int
|
|
serviceFee - Int
|
|
discount - Int
|
|
total - Int
|
|
accountBalanceApplied - Int
|
|
accountBalanceManuallySet - Boolean
|
|
storeCreditApplied - Int
|
|
storeCreditManuallySet - Boolean
|
|
notes - String
|
|
invoicedAt - datetime
|
|
title - String
|
Example
{
"invoiceId": "4",
"clientId": 4,
"items": [InvoiceItemUpdateSchema],
"subtotal": 123,
"isTaxExempt": false,
"tax": 123,
"taxRate": Decimal,
"pstTax": 123,
"pstTaxRate": Decimal,
"fees": 123,
"serviceFee": 987,
"discount": 987,
"total": 123,
"accountBalanceApplied": 123,
"accountBalanceManuallySet": false,
"storeCreditApplied": 123,
"storeCreditManuallySet": true,
"notes": "abc123",
"invoicedAt": datetime,
"title": "xyz789"
}
InvoiceUpdateTreatmentProviderSchema
Fields
| Input Field | Description |
|---|---|
invoiceId - ID!
|
|
treatmentId - ID
|
|
instanceId - ID
|
|
providerId - ID!
|
|
providerCode - ProviderCode
|
Example
{
"invoiceId": 4,
"treatmentId": "4",
"instanceId": 4,
"providerId": 4,
"providerCode": "ER"
}
InvoiceViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
clientId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
updatedAt - DateFilter
|
|
diagnosisName - StrFilter
|
|
paymentStatus - StrFilter
|
|
status - StrFilter
|
|
shortInvoiceId - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"clientId": ListObjectIdFilter,
"createdAt": DateFilter,
"updatedAt": DateFilter,
"diagnosisName": StrFilter,
"paymentStatus": StrFilter,
"status": StrFilter,
"shortInvoiceId": StrFilter
}
InvoiceViewSchema
Fields
| Field Name | Description |
|---|---|
soap - SoapSchema
|
|
surgery - SurgerySchema
|
|
visitNote - VisitNoteSchema
|
|
orderNote - OrderNoteSchema
|
|
id - ID!
|
|
invoiceId - ID
|
|
status - InvoiceStatusEnum
|
|
patientId - ID
|
|
clientId - ID
|
|
creatorUid - ID
|
|
voidedUid - ID
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
estimateId - ID
|
|
parentInvoiceId - ID
|
|
items - [InvoiceItemSchema!]
|
|
subtotal - Int
|
|
isTaxExempt - Boolean
|
|
tax - Int
|
|
taxRate - Float
|
|
pstTax - Int
|
|
pstTaxRate - Float
|
|
clientTaxRate - Float
|
|
taxRateSource - TaxRateSourceEnum
|
|
fees - Int
|
|
serviceFee - Int
|
|
discount - Int
|
|
total - Int
|
|
totalPaid - Int
|
|
totalInvoiceVoid - Int
|
|
totalPaymentCancelled - Int
|
|
outstandingBalance - Int
|
|
accountBalanceApplied - Int
|
|
accountBalanceManuallySet - Boolean
|
|
storeCreditApplied - Int
|
|
storeCreditManuallySet - Boolean
|
|
voidedAt - String
|
|
notes - String
|
|
patient - PatientSchema
|
|
client - ClinicUserSchema
|
|
family - FamilySchema
|
|
title - String
|
|
isInterestCharge - Boolean
|
|
isMigrated - Boolean
|
|
paymentStatus - InvoicePaymentStatusEnum
|
|
shortInvoiceId - String
|
|
createdAt - datetime
|
|
updatedAt - datetime
|
|
invoicedAt - datetime
|
Example
{
"soap": SoapSchema,
"surgery": SurgerySchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"id": 4,
"invoiceId": 4,
"status": "OPEN",
"patientId": 4,
"clientId": "4",
"creatorUid": 4,
"voidedUid": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": 4,
"orderNoteId": "4",
"estimateId": "4",
"parentInvoiceId": "4",
"items": [InvoiceItemSchema],
"subtotal": 123,
"isTaxExempt": true,
"tax": 123,
"taxRate": 987.65,
"pstTax": 987,
"pstTaxRate": 987.65,
"clientTaxRate": 987.65,
"taxRateSource": "CLINIC",
"fees": 987,
"serviceFee": 123,
"discount": 123,
"total": 123,
"totalPaid": 987,
"totalInvoiceVoid": 123,
"totalPaymentCancelled": 987,
"outstandingBalance": 123,
"accountBalanceApplied": 987,
"accountBalanceManuallySet": false,
"storeCreditApplied": 123,
"storeCreditManuallySet": false,
"voidedAt": "xyz789",
"notes": "abc123",
"patient": PatientSchema,
"client": ClinicUserSchema,
"family": FamilySchema,
"title": "xyz789",
"isInterestCharge": false,
"isMigrated": false,
"paymentStatus": "PAID",
"shortInvoiceId": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"invoicedAt": datetime
}
InvoiceViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [InvoiceViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [InvoiceViewSchemaEdge]
}
InvoiceViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - InvoiceViewSchema!
|
|
cursor - String!
|
Example
{
"node": InvoiceViewSchema,
"cursor": "abc123"
}
InvoiceVoidSchema
InvoicesByNoteIdInput
InvoicesLockSchema
Fields
| Input Field | Description |
|---|---|
invoiceIds - [ID!]!
|
Example
{"invoiceIds": [4]}
InvoicesMarkAsPaidSchema
ItemGroupDiscountCreateSchema
ItemGroupDiscountSchema
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
JobTitle
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OWNER"
KennelCreateSchema
KennelSchema
Example
{
"id": "4",
"order": 123,
"kennelType": "xyz789",
"description": "xyz789",
"species": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
KennelUpdateOrderSchema
Fields
| Input Field | Description |
|---|---|
kennels - [KennelUpdateSchema!]!
|
Example
{"kennels": [KennelUpdateSchema]}
KennelUpdateSchema
KennelViewFilterSchema
Fields
| Input Field | Description |
|---|---|
kennelType - String
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"kennelType": "abc123",
"createdAt": DateFilter,
"deletedAt": StrFilter
}
KennelViewSchema
Example
{
"id": "xyz789",
"order": 987,
"kennelType": "abc123",
"species": "xyz789",
"description": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
KennelViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [KennelViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [KennelViewSchemaEdge]
}
KennelViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - KennelViewSchema!
|
|
cursor - String!
|
Example
{
"node": KennelViewSchema,
"cursor": "abc123"
}
LabCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IN_HOUSE"
LabCreateSchema
LabDeviceSchema
Fields
| Field Name | Description |
|---|---|
labTests - [LabTestSchema!]!
|
|
id - ID!
|
MongoDB document ObjectID |
vendor - LabVendor!
|
|
serialNumber - String!
|
|
displayName - String
|
Example
{
"labTests": [LabTestSchema],
"id": 4,
"vendor": "OTHER",
"serialNumber": "abc123",
"displayName": "xyz789"
}
LabFilterSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ObjectIdFilter
|
|
soapId - ObjectIdFilter
|
|
surgeryId - ObjectIdFilter
|
|
visitNoteId - ObjectIdFilter
|
|
orderNoteId - ObjectIdFilter
|
|
patientId - ObjectIdFilter
|
|
providerId - ObjectIdFilter
|
|
status - StrListFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"treatmentId": ObjectIdFilter,
"soapId": ObjectIdFilter,
"surgeryId": ObjectIdFilter,
"visitNoteId": ObjectIdFilter,
"orderNoteId": ObjectIdFilter,
"patientId": ObjectIdFilter,
"providerId": ObjectIdFilter,
"status": StrListFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
LabIntegrationOptionsSchema
Fields
| Field Name | Description |
|---|---|
idexxEnabled - Boolean!
|
|
idexxUsername - String
|
|
zoetisEnabled - Boolean!
|
|
zoetisClientId - String
|
|
antechV6Enabled - Boolean!
|
|
antechV6ClinicId - String
|
|
antechV6Username - String
|
|
ellieEnabled - Boolean!
|
|
ellieClinicId - String
|
|
hl7iOptions - [Hl7iOptionSchema!]
|
|
autoCreateLabTreatment - Boolean!
|
|
autoCreateMarkupFactor - String
|
Example
{
"idexxEnabled": false,
"idexxUsername": "xyz789",
"zoetisEnabled": false,
"zoetisClientId": "abc123",
"antechV6Enabled": false,
"antechV6ClinicId": "xyz789",
"antechV6Username": "abc123",
"ellieEnabled": false,
"ellieClinicId": "xyz789",
"hl7iOptions": [Hl7iOptionSchema],
"autoCreateLabTreatment": false,
"autoCreateMarkupFactor": "xyz789"
}
LabIntegrationOptionsUpdateSchema
Fields
| Input Field | Description |
|---|---|
idexxEnabled - Boolean
|
|
idexxUsername - String
|
|
idexxPassword - String
|
|
zoetisEnabled - Boolean
|
|
zoetisClientId - String
|
|
antechV6Enabled - Boolean
|
|
antechV6ClinicId - String
|
|
antechV6Username - String
|
|
antechV6Password - String
|
|
ellieEnabled - Boolean
|
|
ellieClinicId - String
|
|
hl7iOptions - [Hl7iOptionUpdateSchema!]
|
|
autoCreateLabTreatment - Boolean
|
|
autoCreateMarkupFactor - String
|
Example
{
"idexxEnabled": true,
"idexxUsername": "abc123",
"idexxPassword": "abc123",
"zoetisEnabled": false,
"zoetisClientId": "xyz789",
"antechV6Enabled": false,
"antechV6ClinicId": "xyz789",
"antechV6Username": "abc123",
"antechV6Password": "abc123",
"ellieEnabled": true,
"ellieClinicId": "abc123",
"hl7iOptions": [Hl7iOptionUpdateSchema],
"autoCreateLabTreatment": true,
"autoCreateMarkupFactor": "abc123"
}
LabResultSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
labId - ID
|
|
labName - String
|
|
referenceLow - String
|
|
referenceCriticalLow - String
|
|
referenceHigh - String
|
|
referenceCriticalHigh - String
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
categoryName - String
|
|
categoryCode - String
|
|
name - String
|
|
code - String
|
|
result - String
|
|
resultText - String
|
|
indicator - String
|
|
units - String
|
|
referenceRange - String
|
|
comments - [String!]!
|
|
order - Int
|
|
status - String
|
|
deletedAt - datetime
|
Example
{
"id": 4,
"labId": "4",
"labName": "xyz789",
"referenceLow": "abc123",
"referenceCriticalLow": "xyz789",
"referenceHigh": "abc123",
"referenceCriticalHigh": "abc123",
"createdAt": datetime,
"updatedAt": datetime,
"categoryName": "xyz789",
"categoryCode": "abc123",
"name": "abc123",
"code": "abc123",
"result": "abc123",
"resultText": "xyz789",
"indicator": "abc123",
"units": "abc123",
"referenceRange": "abc123",
"comments": ["xyz789"],
"order": 987,
"status": "xyz789",
"deletedAt": datetime
}
LabResultsCallbackTaskOptionsSchema
LabResultsCallbackTaskOptionsUpdateSchema
LabSchema
Fields
| Field Name | Description |
|---|---|
idexxUiUrl - String
|
|
orderPdfUrl - String
|
|
resultPdfUrl - String
|
|
antechV6OrderUiUrl - String
|
|
antechV6ResultUiUrl - String
|
|
notes - String
|
|
labResults - [LabResultSchema!]!
|
|
treatment - TreatmentSchema!
|
|
surgery - SurgerySchema!
|
|
uiStatus - PatientHistoryItemStatusEnum!
|
|
patient - PatientSchema!
|
|
provider - ClinicUserSchema!
|
|
antechV6Token - String
|
|
idexxResultUrl - String
|
|
id - ID!
|
MongoDB document ObjectID |
treatmentId - ID!
|
References the Treatment model to define what lab test is being performed. Must be a treatment with type_code LABORATORY, validated during save. Used to determine lab vendor, pricing, and test specifications |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
labResultIds - [ID!]!
|
List of LabResult IDs containing the actual test results from lab vendors. Populated when results are received via update_lab_with_results() service method. Empty list until lab processing is complete |
soapId - ID
|
Links this lab to a SOAP note if ordered during a patient visit. Mutually exclusive with surgery_id, visit_note_id, and order_note_id. When set, SOAP note must have valid lock for modifications (verified in service) |
surgeryId - ID
|
Links this lab to a Surgery record if ordered as part of surgical procedures. Mutually exclusive with soap_id, visit_note_id, and order_note_id. References Surgery model, validated during save |
visitNoteId - ID
|
Links this lab to a VisitNote if ordered during a patient visit. Mutually exclusive with soap_id, surgery_id, and order_note_id. References VisitNote model, validated during save |
orderNoteId - ID
|
Links this lab to an OrderNote for standalone lab orders. Mutually exclusive with soap_id, surgery_id, and visit_note_id. References OrderNote model, validated during save |
patientId - ID!
|
References the Patient this lab belongs to. Optional for external orders but logically required for PIMS-created labs. Validated during save to ensure patient exists in clinic. Used for patient history tracking and lab result notifications |
instructions - String
|
Special handling instructions for the lab vendor or clinic staff. Free-text field for additional context about sample collection or processing |
isStaff - Boolean!
|
Indicates if this lab order is for a staff member or clinic employee. Affects billing and processing workflows. Defaults to False for regular patient labs |
providerId - ID!
|
References the User (veterinarian/provider) who ordered this lab. Must be a valid clinic user, validated during save. Used for lab result notifications and ordering accountability. Optional for external orders but logically required for PIMS orders |
status - LabStatus!
|
Current processing status of the lab order through vendor workflow. Automatically updated by vendor integration services during processing. Triggers patient history updates when changed via service methods. Starts as NEW, progresses through CREATED -> SUBMITTED -> INPROCESS -> COMPLETE |
deletedAt - datetime
|
Soft delete timestamp - when set, lab is considered deleted but preserved for audit. Set by delete_lab() service method, which also creates DELETED patient history entry. Used in queries to filter out deleted labs |
Example
{
"idexxUiUrl": "abc123",
"orderPdfUrl": "xyz789",
"resultPdfUrl": "abc123",
"antechV6OrderUiUrl": "xyz789",
"antechV6ResultUiUrl": "abc123",
"notes": "abc123",
"labResults": [LabResultSchema],
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"uiStatus": "ACTION_NEEDED",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"antechV6Token": "abc123",
"idexxResultUrl": "xyz789",
"id": 4,
"treatmentId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"labResultIds": ["4"],
"soapId": "4",
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": "4",
"patientId": 4,
"instructions": "xyz789",
"isStaff": false,
"providerId": 4,
"status": "NEW",
"deletedAt": datetime
}
LabSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [LabSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [LabSchemaEdge]
}
LabSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - LabSchema!
|
|
cursor - String!
|
Example
{
"node": LabSchema,
"cursor": "abc123"
}
LabStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NEW"
LabTestSchema
Fields
| Field Name | Description |
|---|---|
listPrice - Int
|
|
id - String!
|
|
vendor - LabVendor!
|
|
code - String!
|
|
name - String!
|
|
labCat - LabCategory
|
|
price - Int
|
|
highlights - [Highlight!]
|
Example
{
"listPrice": 123,
"id": "abc123",
"vendor": "OTHER",
"code": "abc123",
"name": "xyz789",
"labCat": "IN_HOUSE",
"price": 123,
"highlights": [Highlight]
}
LabTestSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [LabTestSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [LabTestSchemaEdge]
}
LabTestSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - LabTestSchema!
|
|
cursor - String!
|
Example
{
"node": LabTestSchema,
"cursor": "abc123"
}
LabTestSearchFilterInput
Fields
| Input Field | Description |
|---|---|
vendor - LabVendor!
|
|
search - String!
|
|
labCat - LabCategory
|
Example
{
"vendor": "OTHER",
"search": "abc123",
"labCat": "IN_HOUSE"
}
LabTestSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CODE_ASC"
LabTodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
labId - ID!
|
Reference to the lab order (Lab model) that needs processing. Todo is marked completed when lab status changes from NEW/CREATED to any other status. Required field - always populated when lab orders exist |
Example
{
"id": "4",
"completed": false,
"todoType": "VACCINE_CERTIFICATE",
"labId": "4"
}
LabUpdateSchema
LabVendor
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OTHER"
LabelDimensionsSchema
LabelDimensionsUpdateSchema
LabsSchema
Fields
| Field Name | Description |
|---|---|
idexx - IdexxSchema
|
Example
{"idexx": IdexxSchema}
LabsUpdateSchema
Fields
| Input Field | Description |
|---|---|
idexx - IdexxUpdateSchema
|
Example
{"idexx": IdexxUpdateSchema}
LinkCreateSchema
Fields
| Input Field | Description |
|---|---|
url - String!
|
The URL being linked to - must be unique across all links. Enforced by unique index on url field. For IDEXX X-rays, follows format: https://www.idexximagebank.com/studyInstanceView?studyInstanceUID={order_reference_number}. |
description - String
|
Optional human-readable description of what the link contains. Used to provide context about the linked content (e.g., 'X-ray of left hip'). Default = null |
linkType - LinkType
|
Categorizes the type of link for filtering and display purposes. IDEXX_XRAY: Links to IDEXX ImageBank X-ray studies. OTHER: General purpose links for any other content. Defaults to OTHER for backward compatibility. Default = OTHER |
creatorId - ID
|
References the ClinicUser who created this link (app.models.clinic_user.ClinicUser). Optional to support system-generated links without a specific creator. Used for audit trails and permission checks. Default = null |
Example
{
"url": "xyz789",
"description": "abc123",
"linkType": "IDEXX_XRAY",
"creatorId": "4"
}
LinkEstimateToNoteInput
Example
{
"estimateId": "4",
"soapId": 4,
"visitNoteId": 4,
"surgeryId": 4,
"orderNoteId": 4,
"skipTreatments": true,
"bundleOptions": BundleOptionsInput
}
LinkEstimateToNoteResponse
LinkProviderInput
Fields
| Input Field | Description |
|---|---|
employeeId - ID!
|
|
providerId - ID!
|
|
labVendor - LabVendor!
|
Example
{"employeeId": 4, "providerId": 4, "labVendor": "OTHER"}
LinkSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
url - String!
|
The URL being linked to - must be unique across all links. Enforced by unique index on url field. For IDEXX X-rays, follows format: https://www.idexximagebank.com/studyInstanceView?studyInstanceUID={order_reference_number}. |
description - String
|
Optional human-readable description of what the link contains. Used to provide context about the linked content (e.g., 'X-ray of left hip'). |
linkType - LinkType!
|
Categorizes the type of link for filtering and display purposes. IDEXX_XRAY: Links to IDEXX ImageBank X-ray studies. OTHER: General purpose links for any other content. Defaults to OTHER for backward compatibility. |
creatorId - ID
|
References the ClinicUser who created this link (app.models.clinic_user.ClinicUser). Optional to support system-generated links without a specific creator. Used for audit trails and permission checks. |
deletedAt - datetime
|
Soft deletion timestamp - when set, link is considered deleted. Used by GraphQL mutations instead of hard deletion to maintain data integrity. Links with deleted_at set should be filtered out of normal queries. |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"url": "xyz789",
"description": "abc123",
"linkType": "IDEXX_XRAY",
"creatorId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
LinkType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IDEXX_XRAY"
LinkUpdateSchema
ListObjectIdFilter
Fields
| Input Field | Description |
|---|---|
value1 - [String!]!
|
|
operator - ComparisonOperators!
|
|
value2 - String
|
Example
{
"value1": ["xyz789"],
"operator": "EQ",
"value2": "abc123"
}
LocationCreateSchema
LocationFilterSchema
LocationSchema
LocationSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [LocationSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [LocationSchemaEdge]
}
LocationSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - LocationSchema!
|
|
cursor - String!
|
Example
{
"node": LocationSchema,
"cursor": "xyz789"
}
LocationUpdateSchema
LoginAsResponseSchema
LoginAsSchema
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
MarkAsReceivedSkipLinkingSchema
Example
{
"vetcoveItemId": 123,
"orderId": "4",
"isLinked": true,
"quantity": Decimal,
"totalPrice": 987,
"locationId": 4,
"expiredAt": datetime,
"lotId": "xyz789",
"serialNo": "abc123",
"manufacturer": "abc123"
}
MedRouteEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORAL"
MediaCreateSchema
Fields
| Input Field | Description |
|---|---|
resourceId - ID
|
|
resourceType - ResourceTypes!
|
|
groupType - GroupTypes!
|
|
filename - String!
|
|
title - String
|
|
description - String
|
|
key - String
|
Example
{
"resourceId": "4",
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"filename": "xyz789",
"title": "xyz789",
"description": "abc123",
"key": "xyz789"
}
MediaQueryInputSchema
Fields
| Input Field | Description |
|---|---|
groupTypes - [String!]
|
Example
{"groupTypes": ["xyz789"]}
MediaSchema
Fields
| Field Name | Description |
|---|---|
url - String
|
|
signedPostUrl - String
|
|
bucket - String
|
|
visitNote - VisitNoteSchema
|
|
id - ID!
|
MongoDB document ObjectID |
resourceId - ID
|
References the primary key of the related resource this media belongs to. Used to establish ownership relationship with various models based on resource_type. Part of compound unique index for preventing duplicate media entries |
resourceType - ResourceTypes
|
Defines what type of resource this media is associated with. Determines business logic for medical history integration and deletion behavior. When set to MEDICAL_HISTORY, creates/deletes corresponding medical history entries |
groupType - GroupTypes
|
Categorizes the media's purpose and presentation context. Controls how media is displayed and filtered in the UI. Used in S3 key generation for organized file storage structure |
status - MediaStatus
|
Tracks the processing state of the media file. Automatically set to PENDING on creation, updated to DONE/FAILED by background workers. Used to prevent serving incomplete or corrupted files to users |
statusInfo - String
|
Contains error details when status is FAILED. Provides debugging information for failed media processing operations. Cleared when status changes to DONE |
filename - String
|
Original filename of the uploaded media file. Used in S3 key generation and for display purposes. Combined with resource_id and group_type forms part of unique constraint |
deletedAt - String
|
Soft deletion timestamp - media is not physically deleted but marked as deleted. When set, media is filtered out of normal queries but preserved for audit trails. Triggers deletion of associated medical history entries when populated |
title - String
|
Human-readable display name for the media. Used for UI presentation and copied during media duplication operations |
description - String
|
Extended description or notes about the media content. Provides additional context and is preserved during media copying |
summaryGeneratedByAi - Boolean
|
Indicates whether the description/summary was generated by AI. Used to determine when to show AI disclaimer. Defaults to False (human-generated content) |
transcript - String
|
AI-generated transcription of the audio file. Used to populate the description field. |
key - String
|
Optional identifier for versioning or grouping related media files. Used in PDF generation to create unique filenames and prevent duplicates. Part of compound unique index to allow multiple versions of same media type |
createdAt - String
|
|
updatedAt - String
|
Example
{
"url": "abc123",
"signedPostUrl": "abc123",
"bucket": "xyz789",
"visitNote": VisitNoteSchema,
"id": "4",
"resourceId": 4,
"resourceType": "CLINIC_USER",
"groupType": "ATTACHMENT",
"status": "PENDING",
"statusInfo": "xyz789",
"filename": "abc123",
"deletedAt": "xyz789",
"title": "xyz789",
"description": "xyz789",
"summaryGeneratedByAi": true,
"transcript": "xyz789",
"key": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
MediaSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [MediaSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [MediaSchemaEdge]
}
MediaSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - MediaSchema!
|
|
cursor - String!
|
Example
{
"node": MediaSchema,
"cursor": "abc123"
}
MediaSendPdfAsEmailSchema
Example
{
"mediaIds": [4],
"receiverEmail": "xyz789",
"resourceType": "CLINIC_USER",
"resourceId": 4,
"patientId": "4",
"clientId": "4",
"note": "abc123"
}
MediaStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
MediaSummaryRequest
MediaSummaryResponse
MediaUpdateSchema
Example
{
"id": "4",
"status": "PENDING",
"title": "abc123",
"createdAt": datetime,
"description": "abc123",
"summaryGeneratedByAi": true,
"transcript": "abc123"
}
MedicalHistoryItemTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SOAP_NOTE"
MedicalHistoryItemTypeEnumListFilter
Fields
| Input Field | Description |
|---|---|
value1 - [MedicalHistoryItemTypeEnum!]!
|
|
operator - ComparisonOperators!
|
|
value2 - MedicalHistoryItemTypeEnum
|
Example
{"value1": ["SOAP_NOTE"], "operator": "EQ", "value2": "SOAP_NOTE"}
MedicalHistoryOptionsSchema
Fields
| Field Name | Description |
|---|---|
type - MedicalHistoryItemTypeEnum!
|
|
name - String!
|
|
enabled - Boolean!
|
Example
{
"type": "SOAP_NOTE",
"name": "abc123",
"enabled": true
}
MedicalHistoryOptionsUpdateSchema
Fields
| Input Field | Description |
|---|---|
type - MedicalHistoryItemTypeEnum!
|
|
name - String!
|
|
enabled - Boolean
|
Example
{
"type": "SOAP_NOTE",
"name": "abc123",
"enabled": false
}
MedicalHistorySchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
patientId - ID!
|
References the patient this medical history item belongs to (Patient model). Required field - every medical history item must be associated with a patient |
type - MedicalHistoryItemTypeEnum!
|
Categorizes the type of medical history item being tracked. Determines how the item is displayed and processed in the application. Required field - must be one of the predefined enum values |
origItemIds - [ID!]!
|
References to the original source items that created this medical history entry. Can contain multiple IDs when a medical history item represents multiple source records. Used for deduplication - prevents creating duplicate entries for the same source items. Required field - cannot be empty (service enforces this with validation) |
deletedAt - datetime
|
Soft delete timestamp - when set, indicates this medical history item is deleted. Allows for data recovery and maintains referential integrity. When null, the item is considered active and will appear in queries via MedicalHistoryView |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
displayDate - datetime!
|
Controls the chronological ordering of medical history items in patient timeline. Defaults to creation time but can be overridden to reflect the actual medical event date. Used for sorting medical history items in patient views. Indexed for performance when querying patient medical history chronologically |
displayString - String!
|
Deprecated field - previously stored pre-formatted display text for medical history items. No longer used as frontend now handles formatting dynamically. Kept for backward compatibility during migration from PatientHistory model |
Example
{
"id": 4,
"patientId": 4,
"type": "SOAP_NOTE",
"origItemIds": ["4"],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"displayDate": datetime,
"displayString": "abc123"
}
MedicalHistoryUpdateSchema
MedicalHistoryViewFilterSchema
Fields
| Input Field | Description |
|---|---|
deletedAt - StrFilter
|
|
patientId - ObjectIdFilter
|
|
type - MedicalHistoryItemTypeEnumListFilter
|
|
createdAt - DateFilter
|
Example
{
"deletedAt": StrFilter,
"patientId": ObjectIdFilter,
"type": MedicalHistoryItemTypeEnumListFilter,
"createdAt": DateFilter
}
MedicalHistoryViewSchema
Fields
| Field Name | Description |
|---|---|
origItems - [CommunicationSchemaEstimateSchemaFamilyViewSchemaInvoiceViewSchemaLabSchemaLabResultSchemaPrescriptionOrderSchemaPrescriptionFillSchemaMiscNoteSchemaConversationMessageSchemaRxScriptSchemaSoapSchemaSurgerySchemaVisitNoteSchemaOrderNoteSchemaVaccineSchemaMediaSchemaFormSubmissionViewSchemaXraySchemaPatientVitalSchemaTaskSchemaLinkSchemaTreatmentPlanViewSchemaEmailLogSchema!]!
|
|
id - ID!
|
|
patientId - ID!
|
References the patient this medical history item belongs to (Patient model). Required field - every medical history item must be associated with a patient |
type - MedicalHistoryItemTypeEnum!
|
Categorizes the type of medical history item being tracked. Determines how the item is displayed and processed in the application. Required field - must be one of the predefined enum values |
origItemIds - [ID!]!
|
References to the original source items that created this medical history entry. Can contain multiple IDs when a medical history item represents multiple source records. Used for deduplication - prevents creating duplicate entries for the same source items. Required field - cannot be empty (service enforces this with validation) |
deletedAt - datetime
|
Soft delete timestamp - when set, indicates this medical history item is deleted. Allows for data recovery and maintains referential integrity. When null, the item is considered active and will appear in queries via MedicalHistoryView |
createdAt - datetime!
|
Timestamp when the medical history item was created |
updatedAt - datetime!
|
Timestamp when the medical history item was last updated |
displayDate - datetime!
|
Controls the chronological ordering of medical history items in patient timeline. Defaults to creation time but can be overridden to reflect the actual medical event date. Used for sorting medical history items in patient views. Indexed for performance when querying patient medical history chronologically |
displayString - String
|
Deprecated field - previously stored pre-formatted display text for medical history items. No longer used as frontend now handles formatting dynamically. Kept for backward compatibility during migration from PatientHistory model |
Example
{
"origItems": [CommunicationSchema],
"id": 4,
"patientId": "4",
"type": "SOAP_NOTE",
"origItemIds": [4],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"displayDate": datetime,
"displayString": "abc123"
}
MedicalHistoryViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [MedicalHistoryViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [MedicalHistoryViewSchemaEdge]
}
MedicalHistoryViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - MedicalHistoryViewSchema!
|
|
cursor - String!
|
Example
{
"node": MedicalHistoryViewSchema,
"cursor": "abc123"
}
MessageStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
MessageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SMS"
MetaDataSchema
MetaSchema
Fields
| Field Name | Description |
|---|---|
labs - LabsSchema
|
Example
{"labs": LabsSchema}
MetaUpdateSchema
Fields
| Input Field | Description |
|---|---|
labs - LabsUpdateSchema
|
Example
{"labs": LabsUpdateSchema}
MethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CASH"
Metric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMMISSION"
MiscNoteCreateSchema
MiscNoteSchema
MiscNoteUpdateSchema
NamedTotalSchema
Example
{
"grossRevenue": 123,
"discount": 987,
"voidedAmount": 123,
"netRevenue": 123,
"qty": Decimal,
"name": "abc123",
"avgRevenuePerClient": Decimal,
"uniqueInvoiceCount": 987
}
NectarpayPaymentTypeInfo
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
amount - Int!
|
|
count - Int!
|
|
transactions - [NectarpayTransactionSchema!]!
|
Example
{
"id": "abc123",
"amount": 123,
"count": 987,
"transactions": [NectarpayTransactionSchema]
}
NectarpayReportSchema
Fields
| Field Name | Description |
|---|---|
nectarpayByPaymentType - [NectarpayPaymentTypeInfo!]!
|
Example
{"nectarpayByPaymentType": [NectarpayPaymentTypeInfo]}
NectarpayTransactionSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
transaction - TransactionViewSchema!
|
|
payoutId - String
|
|
transactionDetailsUrl - String!
|
|
payout - PayoutSchema
|
|
payoutUrl - String
|
Example
{
"id": "abc123",
"transaction": TransactionViewSchema,
"payoutId": "abc123",
"transactionDetailsUrl": "xyz789",
"payout": PayoutSchema,
"payoutUrl": "abc123"
}
NetworkEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRO_BONO"
NoteType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SOAP"
ObjectIdFilter
Fields
| Input Field | Description |
|---|---|
value1 - String!
|
|
operator - ComparisonOperators!
|
|
value2 - String
|
Example
{
"value1": "abc123",
"operator": "EQ",
"value2": "abc123"
}
OfficeHourEntrySchema
OfficeHourEntryUpdateSchema
OfficeHoursSchema
Fields
| Field Name | Description |
|---|---|
sunday - OfficeHourEntrySchema
|
|
monday - OfficeHourEntrySchema
|
|
tuesday - OfficeHourEntrySchema
|
|
wednesday - OfficeHourEntrySchema
|
|
thursday - OfficeHourEntrySchema
|
|
friday - OfficeHourEntrySchema
|
|
saturday - OfficeHourEntrySchema
|
Example
{
"sunday": OfficeHourEntrySchema,
"monday": OfficeHourEntrySchema,
"tuesday": OfficeHourEntrySchema,
"wednesday": OfficeHourEntrySchema,
"thursday": OfficeHourEntrySchema,
"friday": OfficeHourEntrySchema,
"saturday": OfficeHourEntrySchema
}
OfficeHoursUpdateSchema
Fields
| Input Field | Description |
|---|---|
sunday - OfficeHourEntryUpdateSchema
|
|
monday - OfficeHourEntryUpdateSchema
|
|
tuesday - OfficeHourEntryUpdateSchema
|
|
wednesday - OfficeHourEntryUpdateSchema
|
|
thursday - OfficeHourEntryUpdateSchema
|
|
friday - OfficeHourEntryUpdateSchema
|
|
saturday - OfficeHourEntryUpdateSchema
|
Example
{
"sunday": OfficeHourEntryUpdateSchema,
"monday": OfficeHourEntryUpdateSchema,
"tuesday": OfficeHourEntryUpdateSchema,
"wednesday": OfficeHourEntryUpdateSchema,
"thursday": OfficeHourEntryUpdateSchema,
"friday": OfficeHourEntryUpdateSchema,
"saturday": OfficeHourEntryUpdateSchema
}
OngoingDiagnosisCreateSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ID!
|
|
patientId - ID!
|
|
diagnosis - OngoingDiagnosisObjectSchema!
|
|
diagnosisDate - datetime
|
Example
{
"creatorId": "4",
"patientId": "4",
"diagnosis": OngoingDiagnosisObjectSchema,
"diagnosisDate": datetime
}
OngoingDiagnosisObjectSchema
OngoingDiagnosisSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
creatorId - ID!
|
|
patientId - ID!
|
|
diagnosis - DiagnosisEntrySchema!
|
|
diagnosisDate - datetime!
|
|
status - OngoingDiagnosisStatus!
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"creatorId": "4",
"patientId": 4,
"diagnosis": DiagnosisEntrySchema,
"diagnosisDate": datetime,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
OngoingDiagnosisStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
OngoingDiagnosisUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
status - OngoingDiagnosisStatus
|
Example
{"id": 4, "status": "ACTIVE"}
OngoingDiagnosisViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
creator - ClinicUserSchema!
|
|
patient - PatientSchema!
|
|
diagnosis - DiagnosisEntrySchema!
|
|
diagnosisDate - datetime!
|
|
status - OngoingDiagnosisStatus!
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"creator": ClinicUserSchema,
"patient": PatientSchema,
"diagnosis": DiagnosisEntrySchema,
"diagnosisDate": datetime,
"status": "ACTIVE",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
OnlineAppointmentScheduleSchema
Fields
| Input Field | Description |
|---|---|
appointmentId - ID!
|
|
transaction - TransactionCreateSchema
|
Example
{
"appointmentId": "4",
"transaction": TransactionCreateSchema
}
OnlineBookingConfigSchema
OnlineBookingConfigUpdateSchema
OpenMedicalNotesResponse
Fields
| Field Name | Description |
|---|---|
openNotes - [PatientHistoryItemPaginatedSchema!]!
|
|
totalCount - Int!
|
Example
{
"openNotes": [PatientHistoryItemPaginatedSchema],
"totalCount": 123
}
OrderNoteCreateSchema
OrderNoteSchema
Fields
| Field Name | Description |
|---|---|
patientVitals - PatientVitalSchema
|
|
estimates - [EstimateSchema!]
|
|
invoices - [InvoiceViewSchema!]
|
|
vitals - [PatientVitalSchema!]
|
|
addendums - [AddendumSchema!]
|
|
media - [MediaSchema!]
|
|
creator - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patient - PatientSchema!
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
noteType - NoteType
|
Determines the specific note type - affects display, validation, and auto-lock behavior. Each note type has different auto-lock timeouts and specific business logic |
patientId - ID!
|
Required reference to the patient this note belongs to (ClinicPatient model). Used for patient history tracking and medical record organization |
providerId - ID
|
The primary veterinary provider responsible for this note (ClinicUser model). Auto-populated from appointment assigned employee if they are a provider. Falls back to default vet assigned to patient for current day if no appointment |
creatorUid - ID
|
The user who originally created this note (ClinicUser model). Used for audit trails and permission checks |
techUid - ID
|
The veterinary technician associated with this note (ClinicUser model). Typically assigned during appointment scheduling or note creation |
appointmentId - ID
|
Reference to the appointment this note was created from (Appointment model). Used to inherit appointment details like assigned staff and appointment type |
appointmentTypeId - ID
|
Reference to the type of appointment this note relates to (AppointmentType model). Auto-populated from linked appointment for categorization and reporting |
treatments - [PrescribedTreatmentSchema!]
|
List of prescribed treatments, medications, and procedures for this note. Syncs to invoicing system when auto-charge capture is enabled. Each treatment includes quantity, instructions, pricing, and fulfillment details |
followUps - [FollowUpSchema!]
|
List of recommended follow-up appointments and care instructions. Each follow-up includes appointment type, reason, and recommended timing |
status - SoapStatusEnum
|
Current workflow status of the note - controls editability and triggers side effects. DRAFT: editable, auto-locks after clinic-configured hours. FINAL: locked, triggers patient history updates and patient annotation creation. VOIDED/DELETED: reverses patient annotations and marks as inactive |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
autolockCreatedAt - datetime
|
Optional reference datetime for auto-lock functionality. When set, this datetime is used instead of created_at for calculating auto-lock timing (autolock_created_at + autolock_hours). Allows for custom auto-lock reference timing per note |
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
List of patient body diagrams with annotations for visual medical documentation. When note is finalized, default body diagram annotations are copied to patient annotations. Supports multiple diagram types including body maps and custom medical illustrations |
notes - String
|
Example
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": 4,
"providerId": "4",
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [SoapSurgeryPatientDiagramSchema],
"notes": "xyz789"
}
OrderNoteUpdateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID
|
|
providerId - ID
|
|
techUid - ID
|
|
appointmentId - ID
|
|
appointmentTypeId - ID
|
|
treatments - [PrescribedTreatmentUpdateSchema!]
|
|
followUps - [FollowUpUpdateSchema!]
|
|
status - SoapStatusEnum
|
|
addendumIds - [ID!]
|
|
patientDiagrams - [SoapSurgeryPatientDiagramUpdateSchema!]
|
|
createdAt - datetime
|
|
autolockCreatedAt - datetime
|
|
voidReason - String
|
|
id - ID!
|
|
notes - String
|
Example
{
"patientId": "4",
"providerId": 4,
"techUid": 4,
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentUpdateSchema],
"followUps": [FollowUpUpdateSchema],
"status": "DRAFT",
"addendumIds": [4],
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
],
"createdAt": datetime,
"autolockCreatedAt": datetime,
"voidReason": "abc123",
"id": 4,
"notes": "xyz789"
}
PageInfo
PaginationFilter
PaginationInfo
Fields
| Input Field | Description |
|---|---|
perPage - Int!
|
|
cursor - String
|
|
mode - CursorMode
|
Example
{
"perPage": 987,
"cursor": "abc123",
"mode": "FORWARD"
}
ParentBundleInfoCreateSchema
ParentBundleInfoSchema
PatientAddChatSessionSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
chatSession - ChatSessionUpdateSchema!
|
Example
{"patientId": 4, "chatSession": ChatSessionUpdateSchema}
PatientAnnotationFilterSchema
Fields
| Input Field | Description |
|---|---|
deletedAt - StrFilter
|
|
patientId - ObjectIdFilter
|
|
soapId - ObjectIdFilter
|
|
surgeryId - ObjectIdFilter
|
|
visitNoteId - ObjectIdFilter
|
|
patientDiagramId - ObjectIdFilter
|
|
type - StrFilter
|
|
status - StrFilter
|
Example
{
"deletedAt": StrFilter,
"patientId": ObjectIdFilter,
"soapId": ObjectIdFilter,
"surgeryId": ObjectIdFilter,
"visitNoteId": ObjectIdFilter,
"patientDiagramId": ObjectIdFilter,
"type": StrFilter,
"status": StrFilter
}
PatientAnnotationSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
patientId - ID!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
patientDiagramId - ID!
|
|
description - String!
|
|
color - String!
|
|
status - PatientAnnotationStatusEnum!
|
|
previousId - ID
|
|
coordinates - JSON!
|
|
type - PatientDiagramTypeEnum!
|
|
number - String!
|
|
creatorId - ID
|
|
resolverId - ID
|
|
resolvedAt - datetime
|
|
resolveReason - String
|
|
createdAt - datetime
|
Example
{
"id": "4",
"patientId": "4",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"patientDiagramId": "4",
"description": "xyz789",
"color": "abc123",
"status": "OPEN",
"previousId": "4",
"coordinates": {},
"type": "BODY_DIAGRAM",
"number": "abc123",
"creatorId": 4,
"resolverId": "4",
"resolvedAt": datetime,
"resolveReason": "xyz789",
"createdAt": datetime
}
PatientAnnotationSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PatientAnnotationSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PatientAnnotationSchemaEdge]
}
PatientAnnotationSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PatientAnnotationSchema!
|
|
cursor - String!
|
Example
{
"node": PatientAnnotationSchema,
"cursor": "abc123"
}
PatientAnnotationStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
PatientCreateSchema
Fields
| Input Field | Description |
|---|---|
status - PatientStatus!
|
|
firstName - String!
|
|
species - String!
|
|
lastName - String
|
|
breed - String
|
|
dateOfBirth - datetime
|
|
dateOfDeath - datetime
|
|
color - String
|
|
weightLbs - Float
|
|
weightKg - Float
|
|
gender - Gender
|
|
spayNeuter - Boolean
|
|
photoUrl - String
|
|
warnings - String
|
|
familyId - ID
|
|
contactUid - ID
|
|
microchip - String
|
|
meta - MetaUpdateSchema
|
|
createdVia - PatientCreatedVia
|
Example
{
"status": "ACTIVE",
"firstName": "xyz789",
"species": "xyz789",
"lastName": "xyz789",
"breed": "abc123",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "abc123",
"weightLbs": 123.45,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": false,
"photoUrl": "xyz789",
"warnings": "xyz789",
"familyId": "4",
"contactUid": 4,
"microchip": "abc123",
"meta": MetaUpdateSchema,
"createdVia": "APP"
}
PatientCreatedVia
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APP"
PatientDeceasedOptionsSchema
PatientDeceasedOptionsUpdateSchema
PatientDiagramCreateSchema
Fields
| Input Field | Description |
|---|---|
title - String!
|
Human-readable name for the diagram template (e.g., 'Canine Body Diagram'). Must be unique within species and type combination - enforced by database index. |
species - String!
|
Animal species this diagram applies to (e.g., 'canine', 'feline'). Used for filtering diagrams by patient species. |
type - PatientDiagramTypeEnum!
|
Type of diagram - body_diagram, eye, or dental. Determines the medical context and available annotation tools. |
mediaId - ID!
|
Reference to the base image file for this diagram (Media model). Must be a valid image file that exists in the media system. Validated during creation to ensure media exists. |
creatorId - ID!
|
Reference to the clinic user who created this diagram template (ClinicUser model). Must be an active employee when creating new diagrams. Optional for system-default diagrams. |
Example
{
"title": "xyz789",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": "4",
"creatorId": 4
}
PatientDiagramFilterSchema
Fields
| Input Field | Description |
|---|---|
deletedAt - StrFilter
|
|
title - StrFilter
|
|
species - StrFilter
|
|
type - StrFilter
|
|
nectarDefault - BoolFilter
|
|
creatorId - ObjectIdFilter
|
|
createdAt - DateFilter
|
Example
{
"deletedAt": StrFilter,
"title": StrFilter,
"species": StrFilter,
"type": StrFilter,
"nectarDefault": BoolFilter,
"creatorId": ObjectIdFilter,
"createdAt": DateFilter
}
PatientDiagramSchema
Fields
| Field Name | Description |
|---|---|
media - MediaSchema!
|
|
id - ID!
|
MongoDB document ObjectID |
title - String!
|
Human-readable name for the diagram template (e.g., 'Canine Body Diagram'). Must be unique within species and type combination - enforced by database index. |
species - String!
|
Animal species this diagram applies to (e.g., 'canine', 'feline'). Used for filtering diagrams by patient species. |
type - PatientDiagramTypeEnum!
|
Type of diagram - body_diagram, eye, or dental. Determines the medical context and available annotation tools. |
mediaId - ID!
|
Reference to the base image file for this diagram (Media model). Must be a valid image file that exists in the media system. Validated during creation to ensure media exists. |
nectarDefault - Boolean!
|
Whether this is a system-provided default diagram. Default diagrams cannot be deleted via the service layer. |
creatorId - ID
|
Reference to the clinic user who created this diagram template (ClinicUser model). Must be an active employee when creating new diagrams. Optional for system-default diagrams. |
createdAt - datetime
|
|
updatedAt - datetime
|
|
deletedAt - datetime
|
Soft deletion timestamp - when set, diagram is considered deleted. Used instead of hard deletion to maintain data integrity. |
Example
{
"media": MediaSchema,
"id": 4,
"title": "abc123",
"species": "xyz789",
"type": "BODY_DIAGRAM",
"mediaId": 4,
"nectarDefault": false,
"creatorId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
PatientDiagramTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BODY_DIAGRAM"
PatientDiagramUpdateSchema
PatientDiagramViewSchema
Fields
| Field Name | Description |
|---|---|
media - MediaSchema
|
|
id - ID!
|
|
title - String!
|
Human-readable name for the diagram template (e.g., 'Canine Body Diagram'). |
species - String!
|
Animal species this diagram applies to (e.g., 'canine', 'feline'). |
type - PatientDiagramTypeEnum!
|
Type of diagram - body_diagram, eye, or dental. |
mediaId - ID!
|
Reference to the base image file for this diagram (Media model). |
nectarDefault - Boolean!
|
Whether this is a system-provided default diagram. |
creatorId - ID
|
Reference to the clinic user who created this diagram template (ClinicUser model). |
creator - ClinicUserSchema
|
Populated clinic user object for the creator via aggregation pipeline. Provides access to creator details without additional queries. |
createdAt - datetime
|
|
updatedAt - datetime
|
|
deletedAt - datetime
|
Soft deletion timestamp - when set, diagram is considered deleted. |
Example
{
"media": MediaSchema,
"id": "4",
"title": "abc123",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": "4",
"nectarDefault": false,
"creatorId": "4",
"creator": ClinicUserSchema,
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
PatientDiagramViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PatientDiagramViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PatientDiagramViewSchemaEdge]
}
PatientDiagramViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PatientDiagramViewSchema!
|
|
cursor - String!
|
Example
{
"node": PatientDiagramViewSchema,
"cursor": "xyz789"
}
PatientDocumentsSchema
Fields
Example
{
"rxScripts": [CommunicationSchema],
"invoices": [CommunicationSchema],
"estimates": [CommunicationSchema],
"soaps": [CommunicationSchema],
"surgeries": [CommunicationSchema],
"visitNotes": [CommunicationSchema],
"vaccines": [CommunicationSchema],
"dischargeDocuments": [CommunicationSchema]
}
PatientFilterSchema
Fields
| Input Field | Description |
|---|---|
id - ListObjectIdFilter
|
|
extId - StrFilter
|
|
patientId - ListObjectIdFilter
|
|
contactUid - ListObjectIdFilter
|
|
species - StrFilter
|
|
breed - StrFilter
|
|
color - StrFilter
|
|
gender - StrFilter
|
|
spayNeuter - BoolFilter
|
|
status - StrFilter
|
|
microchip - StrFilter
|
|
createdAt - DateFilter
|
|
dateOfBirth - DateFilter
|
|
firstInvoiceDate - DateFilter
|
|
lastInvoiceDate - DateFilter
|
|
updatedAt - DateFilter
|
Example
{
"id": ListObjectIdFilter,
"extId": StrFilter,
"patientId": ListObjectIdFilter,
"contactUid": ListObjectIdFilter,
"species": StrFilter,
"breed": StrFilter,
"color": StrFilter,
"gender": StrFilter,
"spayNeuter": BoolFilter,
"status": StrFilter,
"microchip": StrFilter,
"createdAt": DateFilter,
"dateOfBirth": DateFilter,
"firstInvoiceDate": DateFilter,
"lastInvoiceDate": DateFilter,
"updatedAt": DateFilter
}
PatientHistoryFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
type - PatientHistoryItemTypeEnumListFilter
|
|
status - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"type": PatientHistoryItemTypeEnumListFilter,
"status": StrFilter
}
PatientHistoryItemPaginatedSchema
Fields
| Field Name | Description |
|---|---|
origItem - CommunicationSchemaEstimateSchemaFamilyViewSchemaInvoiceViewSchemaInvoiceSchemaLabSchemaConversationMessageSchemaRxScriptSchemaSoapSchemaSurgerySchemaVisitNoteSchemaOrderNoteSchemaVaccineSchemaDischargeDocumentSchema
|
|
origItems - [CommunicationSchemaEstimateSchemaFamilyViewSchemaInvoiceViewSchemaInvoiceSchemaLabSchemaConversationMessageSchemaRxScriptSchemaSoapSchemaSurgerySchemaVisitNoteSchemaOrderNoteSchemaVaccineSchemaDischargeDocumentSchema!]!
|
|
patientHistoryItemId - ID!
|
|
patientId - ID!
|
|
origItemId - ID!
|
|
type - PatientHistoryItemTypeEnum!
|
|
status - PatientHistoryItemStatusEnum!
|
|
displayString - String!
|
|
createdAt - datetime!
|
|
origItemIds - [ID!]
|
Example
{
"origItem": CommunicationSchema,
"origItems": [CommunicationSchema],
"patientHistoryItemId": "4",
"patientId": 4,
"origItemId": "4",
"type": "SOAP_NOTE",
"status": "ACTION_NEEDED",
"displayString": "xyz789",
"createdAt": datetime,
"origItemIds": [4]
}
PatientHistoryItemPaginatedSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PatientHistoryItemPaginatedSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PatientHistoryItemPaginatedSchemaEdge]
}
PatientHistoryItemPaginatedSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PatientHistoryItemPaginatedSchema!
|
|
cursor - String!
|
Example
{
"node": PatientHistoryItemPaginatedSchema,
"cursor": "abc123"
}
PatientHistoryItemSchema
Fields
| Field Name | Description |
|---|---|
patientHistoryItemId - ID!
|
|
patientId - ID!
|
|
origItemId - ID!
|
|
type - PatientHistoryItemTypeEnum!
|
|
status - PatientHistoryItemStatusEnum!
|
|
displayString - String!
|
|
createdAt - datetime!
|
|
origItemIds - [ID!]
|
Example
{
"patientHistoryItemId": "4",
"patientId": "4",
"origItemId": "4",
"type": "SOAP_NOTE",
"status": "ACTION_NEEDED",
"displayString": "xyz789",
"createdAt": datetime,
"origItemIds": [4]
}
PatientHistoryItemSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PatientHistoryItemSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PatientHistoryItemSchemaEdge]
}
PatientHistoryItemSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PatientHistoryItemSchema!
|
|
cursor - String!
|
Example
{
"node": PatientHistoryItemSchema,
"cursor": "abc123"
}
PatientHistoryItemStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTION_NEEDED"
PatientHistoryItemTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SOAP_NOTE"
PatientHistoryItemTypeEnumListFilter
Fields
| Input Field | Description |
|---|---|
value1 - [PatientHistoryItemTypeEnum!]!
|
|
operator - ComparisonOperators!
|
|
value2 - PatientHistoryItemTypeEnum
|
Example
{"value1": ["SOAP_NOTE"], "operator": "EQ", "value2": "SOAP_NOTE"}
PatientIndexSchema
PatientMergeInput
Example
{
"sourcePatientId": "4",
"destinationPatientId": 4,
"useTransaction": false
}
PatientProfileDiagramSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
title - String!
|
|
species - String!
|
|
type - PatientDiagramTypeEnum!
|
|
mediaId - ID!
|
|
nectarDefault - Boolean!
|
|
creatorId - ID
|
|
createdAt - datetime
|
|
updatedAt - datetime
|
|
deletedAt - datetime
|
|
annotations - [PatientAnnotationSchema!]
|
|
media - MediaSchema!
|
Example
{
"id": 4,
"title": "xyz789",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": 4,
"nectarDefault": false,
"creatorId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"annotations": [PatientAnnotationSchema],
"media": MediaSchema
}
PatientQueryFilter
PatientReportNamedTotalSchema
Example
{
"name": "xyz789",
"newPatientCount": 987,
"existingPatientCount": 123,
"activePatientCount": 987,
"lapsingPatientCount": 987,
"lapsedPatientCount": 123
}
PatientReportSchema
Fields
| Field Name | Description |
|---|---|
newAndExistingPatientTotals - [PatientReportNamedTotalSchema!]!
|
|
activeLapsingLapsedPatientTotals - [PatientReportNamedTotalSchema!]!
|
Example
{
"newAndExistingPatientTotals": [
PatientReportNamedTotalSchema
],
"activeLapsingLapsedPatientTotals": [
PatientReportNamedTotalSchema
]
}
PatientSchema
Fields
| Field Name | Description |
|---|---|
otherPatients - [PatientSchema!]
|
|
profilePicture - MediaSchema
|
|
hasActiveCheckout - Boolean!
|
|
family - FamilyViewSchema
|
|
patientId - ID!
|
|
extId - String
|
Auto-generated external identifier in format ' |
familyId - ID
|
Reference to the family this patient belongs to (Family model). Required field - patients must belong to a family for billing and contact purposes. Can be transferred to different families via transfer_clinic_patient service method. When transferred, old family moves patient to transferred_patients list |
contactUid - ID
|
Reference to the primary contact person for this patient (ClinicUser model). Optional but typically populated - defaults to family's primary_contact_uid during creation. Updated automatically when patient is transferred between families. Used for communication and authorization purposes |
firstName - String!
|
Patient's given name - used for identification and record keeping. Required field - must be provided during patient creation. Combined with last_name for full patient identification. Indexed for search functionality |
status - PatientStatus
|
Current status of the patient affecting business logic. ACTIVE: Default status, patient can have appointments and receive services. INACTIVE: Patient temporarily inactive, may affect appointment scheduling. DECEASED: Automatically removes future appointments and active reminders. TRANSFERRED: Set when patient is moved between families. Status changes trigger automated actions in appointment and reminder services |
species - String!
|
Species classification (e.g., 'dog', 'cat', 'bird'). Required field - used for breed validation, medical protocols, and diagram selection. Links to Species model for additional species information and imagery. Referenced in patient diagram lookups and breed aggregation queries |
lastName - String
|
Patient's family name - typically inherited from family during creation. Optional field - automatically populated from family.family_name or primary contact's last_name. Used in combination with first_name for patient identification. Indexed for search functionality |
breed - String
|
Breed name as string (e.g., 'Golden Retriever', 'Persian'). Optional field - used for medical protocols and record keeping. Links to Breed model via aggregation pipeline for additional breed information. Validated against existing breeds for the patient's species |
dateOfBirth - datetime
|
Patient's birth date for age calculations and medical protocols. Optional field - used by get_age() method to calculate current age in years. Important for age-appropriate medical care and vaccination schedules |
dateOfDeath - datetime
|
Date of patient's death - set when status changed to DECEASED. Optional field - used for record keeping and preventing future appointments. Affects search results based on clinic settings for showing deceased patients |
color - String
|
Physical color/markings description for patient identification. Optional field - used for patient identification and record keeping. Indexed as part of breed/color search functionality |
weightLbs - Float
|
Patient weight in pounds with 4 decimal precision. Optional field - automatically updated from latest PatientVital weight measurements. Synchronized with weight_kg field through conversion in PatientVital operations. Updated when new vitals are created or when latest vital is deleted |
weightKg - Float
|
Patient weight in kilograms with 4 decimal precision. Optional field - automatically updated from latest PatientVital weight measurements. Synchronized with weight_lbs field through conversion in PatientVital operations. Updated when new vitals are created or when latest vital is deleted |
gender - Gender
|
Patient's biological sex - used for medical protocols and spay/neuter tracking. Optional field - important for breeding, medical care, and surgical procedures. Affects available medical treatments and vaccination protocols |
spayNeuter - Boolean
|
Spay/neuter status affecting medical care and breeding considerations. Optional field - can be automatically updated to True when invoice items have spay_patient_on_checkout=True. Important for medical protocols, anesthesia considerations, and breeding records |
photoUrl - String
|
Legacy photo URL field - being replaced by profile_picture_media_id. Optional field - prefer using profile_picture_media_id for new implementations. May contain external URLs or temporary image locations |
warnings - String
|
Free-text warnings and alerts for patient handling and medical care. Optional field - displayed prominently to alert staff of behavioral, medical, or handling concerns. Critical for staff safety and appropriate patient care |
microchip - String
|
Microchip identification number for pet identification. Optional field - unique identifier for lost pet recovery. Indexed for quick lookup when scanning found animals |
chatSessions - [ChatSessionSchema!]
|
Collection of AI chat sessions for patient-related inquiries. Optional field - stores conversation history for AI-assisted patient care. Each session includes question, session_id, and timestamp |
meta - MetaSchema
|
Structured metadata for integration with external systems. Optional field - currently used for lab system identifiers (IDEXX, etc.). Extensible structure for storing integration-specific data. Searchable via read_patient_by_meta_field for external system lookups |
highlights - [Highlight!]
|
Search result highlights from MongoDB Atlas Search. Optional field - populated during search operations to show matching text. Not stored in database, added dynamically during search aggregation |
profilePictureMediaId - ID
|
Reference to profile picture in Media model. Optional field - preferred method for patient photos over photo_url. Links to Media model for proper file management and access control. Populated via aggregation pipeline in search and read operations |
patientBreed - BreedSchema
|
Breed information object populated from breed string. Optional field - not stored in database, populated via aggregation lookup. Contains full breed details including species validation and imagery. Populated by _add_nested_patient_objects service method |
speciesInfo - SpeciesSchema
|
Species information object populated from species string. Optional field - not stored in database, populated via aggregation lookup. Contains full species details including imagery and custom species flags. Populated by _add_nested_patient_objects service method |
contact - ClinicUserSchema
|
|
createdVia - PatientCreatedVia
|
Indicates how the patient record was created. Optional field - defaults to APP for staff-created records. CLIENT_PORTAL value triggers automated email notifications to family. Used for tracking patient creation sources and triggering appropriate workflows |
patientVitals - [PatientVitalSchema!]
|
Collection of recent patient vital signs. Optional field - populated dynamically when reading patient details. Not stored in database, populated from PatientVital collection. Limited to most recent vitals for performance (default 8 records) |
indexedAt - datetime
|
Timestamp of last medical data indexing for AI/search purposes. Optional field - tracks when patient data was last processed for search indexing. Updated by index_clinic_patient service method during AI data processing |
firstInvoiceDate - datetime
|
Date of patient's first invoice for financial reporting. Optional field - used for patient lifecycle and revenue tracking. Automatically calculated from invoice history |
lastInvoiceDate - datetime
|
Date of patient's most recent invoice for financial reporting. Optional field - used for patient activity tracking and follow-up. Automatically calculated from invoice history |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"otherPatients": [PatientSchema],
"profilePicture": MediaSchema,
"hasActiveCheckout": false,
"family": FamilyViewSchema,
"patientId": 4,
"extId": "abc123",
"familyId": "4",
"contactUid": 4,
"firstName": "abc123",
"status": "ACTIVE",
"species": "xyz789",
"lastName": "abc123",
"breed": "xyz789",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 123.45,
"gender": "MALE",
"spayNeuter": false,
"photoUrl": "xyz789",
"warnings": "abc123",
"microchip": "abc123",
"chatSessions": [ChatSessionSchema],
"meta": MetaSchema,
"highlights": [Highlight],
"profilePictureMediaId": 4,
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"contact": ClinicUserSchema,
"createdVia": "APP",
"patientVitals": [PatientVitalSchema],
"indexedAt": datetime,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
PatientSchemaClinicUserSchema
Types
| Union Types |
|---|
Example
PatientSchema
PatientSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PatientSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PatientSchemaEdge]
}
PatientSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PatientSchema!
|
|
cursor - String!
|
Example
{
"node": PatientSchema,
"cursor": "abc123"
}
PatientSearchResultSchema
Fields
| Field Name | Description |
|---|---|
node - PatientSchema!
|
|
highlights - [HighlightSchema!]
|
|
score - Float
|
Example
{
"node": PatientSchema,
"highlights": [HighlightSchema],
"score": 123.45
}
PatientStatsNamedTotalSchema
PatientStatsReportItemSchema
Example
{
"species": "xyz789",
"breed": "abc123",
"gender": "xyz789",
"age": 123.45,
"status": "xyz789",
"createdAt": datetime,
"lastInvoiceDate": datetime
}
PatientStatsReportSchema
Fields
| Field Name | Description |
|---|---|
speciesTotals - [PatientStatsNamedTotalSchema!]!
|
|
breedTotals - [PatientStatsNamedTotalSchema!]!
|
|
genderTotals - [PatientStatsNamedTotalSchema!]!
|
|
ageGroupTotals - [PatientStatsNamedTotalSchema!]!
|
|
statusTotals - [PatientStatsNamedTotalSchema!]!
|
|
patientStatsReportItems - [PatientStatsReportItemSchema!]!
|
Example
{
"speciesTotals": [PatientStatsNamedTotalSchema],
"breedTotals": [PatientStatsNamedTotalSchema],
"genderTotals": [PatientStatsNamedTotalSchema],
"ageGroupTotals": [PatientStatsNamedTotalSchema],
"statusTotals": [PatientStatsNamedTotalSchema],
"patientStatsReportItems": [
PatientStatsReportItemSchema
]
}
PatientStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
PatientUnifiedFilter
Fields
| Input Field | Description |
|---|---|
contactUid - ListObjectIdFilter
|
Example
{"contactUid": ListObjectIdFilter}
PatientUpdateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
status - PatientStatus
|
|
firstName - String
|
|
species - String
|
|
lastName - String
|
|
breed - String
|
|
dateOfBirth - datetime
|
|
dateOfDeath - datetime
|
|
color - String
|
|
weightLbs - Float
|
|
weightKg - Float
|
|
gender - Gender
|
|
spayNeuter - Boolean
|
|
photoUrl - String
|
|
warnings - String
|
|
familyId - ID
|
|
contactUid - ID
|
|
profilePictureMediaId - ID
|
|
microchip - String
|
|
chatSessions - [ChatSessionUpdateSchema!]
|
|
meta - MetaUpdateSchema
|
Example
{
"patientId": "4",
"status": "ACTIVE",
"firstName": "xyz789",
"species": "xyz789",
"lastName": "abc123",
"breed": "abc123",
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"color": "xyz789",
"weightLbs": 987.65,
"weightKg": 987.65,
"gender": "MALE",
"spayNeuter": false,
"photoUrl": "xyz789",
"warnings": "abc123",
"familyId": "4",
"contactUid": "4",
"profilePictureMediaId": "4",
"microchip": "xyz789",
"chatSessions": [ChatSessionUpdateSchema],
"meta": MetaUpdateSchema
}
PatientViewSchema
Fields
| Field Name | Description |
|---|---|
photoUrl - String
|
|
profilePictureMediaId - ID
|
|
contact - ClinicUserSchema
|
|
createdVia - PatientCreatedVia
|
|
id - ID!
|
|
patientId - ID!
|
|
extId - String
|
|
familyId - ID
|
|
contactUid - ID
|
|
firstName - String!
|
|
firstNameLowercase - String!
|
|
status - PatientStatus
|
|
species - String!
|
|
lastName - String
|
|
breed - String
|
|
patientBreed - BreedSchema
|
|
speciesInfo - SpeciesSchema
|
|
dateOfBirth - datetime
|
|
dateOfDeath - datetime
|
|
weightLbs - Float
|
|
weightKg - Float
|
|
color - String
|
|
gender - Gender
|
|
spayNeuter - Boolean
|
|
warnings - String
|
|
chatSessions - [ChatSessionSchema!]
|
|
microchip - String
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
client - ClinicUserSchema
|
|
family - FamilySchema
|
|
profilePicture - MediaSchema
|
|
firstInvoiceDate - datetime
|
|
lastInvoiceDate - datetime
|
Example
{
"photoUrl": "abc123",
"profilePictureMediaId": 4,
"contact": ClinicUserSchema,
"createdVia": "APP",
"id": 4,
"patientId": 4,
"extId": "abc123",
"familyId": "4",
"contactUid": "4",
"firstName": "xyz789",
"firstNameLowercase": "xyz789",
"status": "ACTIVE",
"species": "abc123",
"lastName": "abc123",
"breed": "xyz789",
"patientBreed": BreedSchema,
"speciesInfo": SpeciesSchema,
"dateOfBirth": datetime,
"dateOfDeath": datetime,
"weightLbs": 987.65,
"weightKg": 987.65,
"color": "xyz789",
"gender": "MALE",
"spayNeuter": true,
"warnings": "abc123",
"chatSessions": [ChatSessionSchema],
"microchip": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"client": ClinicUserSchema,
"family": FamilySchema,
"profilePicture": MediaSchema,
"firstInvoiceDate": datetime,
"lastInvoiceDate": datetime
}
PatientViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PatientViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PatientViewSchemaEdge]
}
PatientViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PatientViewSchema!
|
|
cursor - String!
|
Example
{
"node": PatientViewSchema,
"cursor": "xyz789"
}
PatientVitalCreateSchema
Example
{
"patientId": 4,
"employeeUid": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"bcs": 123,
"weightLb": 123.45,
"weightKg": 987.65,
"heartRate": 123,
"tempF": 987.65,
"tempC": 987.65,
"resp": 987,
"bpDia": 987,
"bpSys": 987,
"crt": Decimal,
"painScore": 987,
"periodontalDisease": 123
}
PatientVitalSchema
Fields
| Field Name | Description |
|---|---|
visitNoteId - ID
|
|
patientVitalId - ID!
|
|
patientId - ID!
|
Reference to the patient this vital record belongs to (ClinicPatient model). Required field - creates medical history entry and updates patient weight when saved. Indexed for efficient retrieval of patient's vital history |
employeeUid - ID!
|
Reference to the employee who recorded the vital signs (ClinicUser model). Required field - used for audit trails and accountability. Important for tracking who performed measurements |
soapId - ID
|
Optional reference to SOAP note if vitals were recorded during exam (Soap model). When provided, patient_id must match the SOAP note's patient_id (validated in service). Used to group vitals with specific medical encounters |
surgeryId - ID
|
Optional reference to surgery if vitals were recorded during procedure (Surgery model). When provided, patient_id must match the surgery's patient_id (validated in service). Used to track vital signs during surgical procedures |
bcs - Int
|
Body condition score on 1-10 scale for nutritional assessment. Optional field - veterinary standard for evaluating patient body condition. Higher scores indicate overweight/obese conditions |
weightLb - Float
|
Patient weight in pounds with 4 decimal precision. Optional field - automatically converts to weight_kg when only one is provided. Updates patient's weight_lbs field when this vital becomes the most recent. Conversion uses Weight.to_kg() utility with precise decimal handling |
weightKg - Float
|
Patient weight in kilograms with 4 decimal precision. Optional field - automatically converts to weight_lb when only one is provided. Updates patient's weight_kg field when this vital becomes the most recent. Conversion uses Weight.to_lb() utility with precise decimal handling |
heartRate - Int
|
Heart rate measurement in beats per minute. Optional field - critical vital sign for cardiovascular assessment. Normal ranges vary by species, age, and size |
tempF - Float
|
Body temperature in Fahrenheit. Optional field - critical vital sign for detecting fever/hypothermia. Normal ranges vary by species (typically 101-102.5°F for dogs/cats) |
tempC - Float
|
Body temperature in Celsius. Optional field - alternative temperature measurement unit. Automatically calculated if temp_f is provided, or vice versa |
resp - Int
|
Respiratory rate in breaths per minute. Optional field - important indicator of respiratory health and stress. Normal ranges vary by species and patient anxiety level |
bpDia - Int
|
Diastolic blood pressure (bottom number). Optional field - measures pressure when heart is relaxed between beats. Used in combination with bp_sys for cardiovascular assessment |
bpSys - Int
|
Systolic blood pressure (top number). Optional field - measures pressure when heart contracts. Critical for detecting hypertension and cardiovascular disease |
crt - Float
|
Capillary refill time measured in seconds. Optional field - indicates circulation and perfusion status. Normal CRT is typically less than 2 seconds in healthy animals |
painScore - Int
|
Pain assessment score on 1-10 scale. Optional field - subjective assessment of patient discomfort level. Critical for pain management and treatment planning |
periodontalDisease - Int
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"visitNoteId": 4,
"patientVitalId": "4",
"patientId": 4,
"employeeUid": 4,
"soapId": 4,
"surgeryId": 4,
"bcs": 987,
"weightLb": 123.45,
"weightKg": 123.45,
"heartRate": 987,
"tempF": 987.65,
"tempC": 123.45,
"resp": 987,
"bpDia": 987,
"bpSys": 123,
"crt": 987.65,
"painScore": 123,
"periodontalDisease": 987,
"createdAt": datetime,
"updatedAt": datetime
}
PatientVitalUpdateSchema
Fields
| Input Field | Description |
|---|---|
patientVitalId - ID!
|
|
employeeUid - ID!
|
|
patientId - ID!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
bcs - Int
|
|
weightLb - Decimal
|
|
weightKg - Decimal
|
|
heartRate - Int
|
|
tempF - Float
|
|
tempC - Float
|
|
resp - Int
|
|
bpDia - Int
|
|
bpSys - Int
|
|
crt - Float
|
|
painScore - Int
|
|
periodontalDisease - Int
|
Example
{
"patientVitalId": 4,
"employeeUid": "4",
"patientId": 4,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": 4,
"bcs": 987,
"weightLb": Decimal,
"weightKg": Decimal,
"heartRate": 987,
"tempF": 123.45,
"tempC": 123.45,
"resp": 123,
"bpDia": 987,
"bpSys": 987,
"crt": 123.45,
"painScore": 123,
"periodontalDisease": 987
}
PauseSubscriptionInput
PaymentIntentBillingDetailsSchema
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{"name": "abc123"}
PaymentIntentCustomerSchema
PaymentIntentPaymentMethodSchema
Fields
| Field Name | Description |
|---|---|
card - CardPaymentMethodSchema
|
|
id - String
|
|
type - String
|
|
createdAt - String
|
|
updatedAt - String
|
Example
{
"card": CardPaymentMethodSchema,
"id": "xyz789",
"type": "abc123",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
PaymentIntentSchema
Fields
| Field Name | Description |
|---|---|
billingDetails - PaymentIntentBillingDetailsSchema!
|
|
id - String!
|
|
amount - Int!
|
|
status - String!
|
|
updatedAt - String!
|
|
customer - PaymentIntentCustomerSchema!
|
|
paymentMethod - PaymentIntentPaymentMethodSchema!
|
Example
{
"billingDetails": PaymentIntentBillingDetailsSchema,
"id": "xyz789",
"amount": 123,
"status": "xyz789",
"updatedAt": "xyz789",
"customer": PaymentIntentCustomerSchema,
"paymentMethod": PaymentIntentPaymentMethodSchema
}
PaymentIntentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELED"
PaymentMethodSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
chargeable - Boolean!
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
type - String
|
|
achDebit - AchDebitSchema
|
|
eftDebit - EftDebitSchema
|
|
billingDetails - BillingDetailsSchema
|
|
expiresAt - String
|
|
customerId - String
|
|
metadata - MetaDataSchema
|
|
nickName - String
|
|
card - CardSchema
|
Example
{
"id": "xyz789",
"chargeable": false,
"createdAt": "abc123",
"updatedAt": "xyz789",
"type": "abc123",
"achDebit": AchDebitSchema,
"eftDebit": EftDebitSchema,
"billingDetails": BillingDetailsSchema,
"expiresAt": "abc123",
"customerId": "xyz789",
"metadata": MetaDataSchema,
"nickName": "abc123",
"card": CardSchema
}
PaymentMethodType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARD"
PaymentTodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
invoiceId - ID
|
Reference to the invoice (Invoice model) requiring payment. May be None if invoice hasn't been created yet |
paymentStatus - InvoicePaymentStatusEnum
|
Current payment status from the Invoice model. Todo is marked completed when status equals PAID |
Example
{
"id": 4,
"completed": false,
"todoType": "VACCINE_CERTIFICATE",
"invoiceId": "4",
"paymentStatus": "PAID"
}
PayoutSchema
Example
{
"amount": 987,
"createdAt": datetime,
"currency": "AUD",
"id": "xyz789",
"status": "CANCELED",
"updatedAt": datetime,
"paidAt": datetime
}
PayoutStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELED"
PdfAlignment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RIGHT"
PdfSettingsSchema
Fields
| Field Name | Description |
|---|---|
alignment - PdfAlignment
|
|
invoiceForceSinglePage - Boolean!
|
Example
{"alignment": "RIGHT", "invoiceForceSinglePage": true}
PdfSettingsUpdateSchema
Fields
| Input Field | Description |
|---|---|
alignment - PdfAlignment
|
|
invoiceForceSinglePage - Boolean
|
Example
{"alignment": "RIGHT", "invoiceForceSinglePage": true}
PermissionCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GENERAL"
PermissionSchema
Example
{
"id": 4,
"name": "abc123",
"description": "abc123",
"key": "xyz789",
"category": "GENERAL",
"createdAt": datetime,
"updatedAt": datetime
}
PhoneType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MOBILE"
PostopSchema
Example
{
"numOxygenationMin": 987,
"isEttExtubated": true,
"notes": "xyz789"
}
PostopUpdateSchema
PreFilterInput
Fields
| Input Field | Description |
|---|---|
patientId - String
|
Example
{"patientId": "abc123"}
PreferredCommunicationMethods
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CALL"
PreopSchema
PreopUpdateSchema
PrescribedTreatmentCreateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID
|
Reference to the original treatment template (Treatment model). Default = null |
instanceId - ID!
|
Unique identifier for this specific prescribed instance. Default = "69351b2adb8057c850228f1f" |
declined - Boolean
|
Whether the client declined this treatment. Default = false |
filledById - ID
|
Reference to user who filled/administered the treatment (ClinicUser model). Default = null |
prescribedById - ID
|
Reference to user who prescribed the treatment (ClinicUser model). Default = null |
prescribedAt - datetime
|
When the treatment was prescribed. Default = null |
expiresAt - datetime
|
When the prescription expires (for medications). Default = null |
labId - ID
|
Reference to associated lab order (Lab model) - allows separate tracking. Default = null |
xrayId - ID
|
Reference to associated x-ray order (Xray model). Default = null |
vaccineId - ID
|
Reference to associated vaccine record (Vaccine model). Default = null |
scheduledEvents - [ScheduledEventCreateSchema!]
|
List of scheduled events for this treatment (e.g., repeat doses). Default = null |
name - String
|
Display name for the treatment (snapshot from Treatment). If Treatment has custom_name use that, otherwise use name |
unit - UnitEnum
|
Unit of measurement (items, ml, mg, etc.) |
pricePerUnit - Int
|
Price per unit in cents (snapshot from Treatment at time of prescription) |
instructions - String
|
Instructions for administration or use. Default = null |
adminFee - Int
|
Additional administration fee in cents. Default = 0 |
minimumCharge - Int
|
Minimum charge in cents regardless of quantity. Default = 0 |
qty - Decimal!
|
Quantity prescribed or administered. Default = "1.00" |
customDoseUnit - String
|
Custom dose unit for prescriptions (e.g., 'tablets'). Default = null |
route - MedRouteEnum
|
Route of administration (oral, injection, topical, inhalation). Default = null |
freq - String
|
Frequency of administration (deprecated - use instructions). Default = null |
duration - Int
|
Duration of treatment in time units. Default = null |
durUnit - DurationUnitEnum
|
Unit for duration (days, weeks, months). Default = null |
refills - Int
|
Number of refills allowed for prescriptions. Default = null |
beforeDatetime - datetime
|
Must be administered before this date/time. Default = null |
fulfill - PrescriptionFulfillEnum
|
How prescription should be fulfilled (in-house, pharmacy, give script). Default = null |
markupFactor - Decimal
|
Markup factor for cost-plus pricing. Default = null |
priceType - PriceTypeEnum
|
Pricing method (fixed, markup, markup from cost, non-billable). Default = null |
rxScriptId - ID
|
Reference to prescription script document. Default = null |
dischargeDocumentIds - [ID!]
|
List of discharge document IDs associated with this treatment. Default = [] |
isCustomTreatment - Boolean
|
Whether this is a custom treatment not in the standard catalog. Default = false |
customTreatmentIsRxScript - Boolean
|
Whether this custom treatment is an RX script. Defaults to True for custom treatments. Default = true |
clinicCostPerUnit - Int
|
Clinic's cost per unit in cents (for profit calculations). Default = null |
parentBundleInfo - ParentBundleInfoCreateSchema
|
Information about the parent bundle if this treatment is part of a bundle. Default = null |
dose - Decimal
|
|
createdAt - String
|
Example
{
"treatmentId": "4",
"instanceId": 4,
"declined": true,
"filledById": "4",
"prescribedById": 4,
"prescribedAt": datetime,
"expiresAt": datetime,
"labId": "4",
"xrayId": 4,
"vaccineId": 4,
"scheduledEvents": [ScheduledEventCreateSchema],
"name": "xyz789",
"unit": "ML",
"pricePerUnit": 987,
"instructions": "abc123",
"adminFee": 123,
"minimumCharge": 987,
"qty": Decimal,
"customDoseUnit": "xyz789",
"route": "ORAL",
"freq": "abc123",
"duration": 987,
"durUnit": "MINUTES",
"refills": 123,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"rxScriptId": 4,
"dischargeDocumentIds": [4],
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 123,
"parentBundleInfo": ParentBundleInfoCreateSchema,
"dose": Decimal,
"createdAt": "xyz789"
}
PrescribedTreatmentSchema
Fields
| Field Name | Description |
|---|---|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
isDiscountable - Boolean
|
|
isControlledSubstance - Boolean
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
|
treatment - TreatmentSchema
|
|
treatmentId - ID
|
Reference to the original treatment template (Treatment model) |
instanceId - ID!
|
Unique identifier for this specific prescribed instance |
declined - Boolean
|
Whether the client declined this treatment |
filledById - ID
|
Reference to user who filled/administered the treatment (ClinicUser model) |
prescribedById - ID
|
Reference to user who prescribed the treatment (ClinicUser model) |
prescribedAt - datetime
|
When the treatment was prescribed |
expiresAt - datetime
|
When the prescription expires (for medications) |
labId - ID
|
Reference to associated lab order (Lab model) - allows separate tracking |
xrayId - ID
|
Reference to associated x-ray order (Xray model) |
vaccineId - ID
|
Reference to associated vaccine record (Vaccine model) |
scheduledEvents - [ScheduledEventSchema!]
|
List of scheduled events for this treatment (e.g., repeat doses) |
name - String!
|
Display name for the treatment (snapshot from Treatment). If Treatment has custom_name use that, otherwise use name |
unit - UnitEnum!
|
Unit of measurement (items, ml, mg, etc.) |
pricePerUnit - Int!
|
Price per unit in cents (snapshot from Treatment at time of prescription) |
instructions - String
|
Instructions for administration or use |
adminFee - Int!
|
Additional administration fee in cents |
minimumCharge - Int!
|
Minimum charge in cents regardless of quantity |
qty - Decimal!
|
Quantity prescribed or administered |
customDoseUnit - String
|
Custom dose unit for prescriptions (e.g., 'tablets') |
route - MedRouteEnum
|
Route of administration (oral, injection, topical, inhalation) |
freq - String
|
Frequency of administration (deprecated - use instructions) |
duration - Int
|
Duration of treatment in time units |
durUnit - DurationUnitEnum
|
Unit for duration (days, weeks, months) |
refills - Int
|
Number of refills allowed for prescriptions |
beforeDatetime - datetime
|
Must be administered before this date/time |
fulfill - PrescriptionFulfillEnum
|
How prescription should be fulfilled (in-house, pharmacy, give script) |
markupFactor - Decimal
|
Markup factor for cost-plus pricing |
priceType - PriceTypeEnum
|
Pricing method (fixed, markup, markup from cost, non-billable) |
rxScriptId - ID
|
Reference to prescription script document |
dischargeDocumentIds - [ID!]
|
List of discharge document IDs associated with this treatment |
isCustomTreatment - Boolean
|
Whether this is a custom treatment not in the standard catalog |
customTreatmentIsRxScript - Boolean
|
Whether this custom treatment is an RX script. Defaults to True for custom treatments. |
clinicCostPerUnit - Int
|
Clinic's cost per unit in cents (for profit calculations) |
parentBundleInfo - ParentBundleInfoSchema
|
Information about the parent bundle if this treatment is part of a bundle |
dose - Decimal
|
|
createdAt - datetime!
|
Example
{
"isTaxable": true,
"isPstTaxable": true,
"isDiscountable": true,
"isControlledSubstance": true,
"useVendorCost": false,
"vendorListPrice": 987,
"treatment": TreatmentSchema,
"treatmentId": 4,
"instanceId": "4",
"declined": true,
"filledById": "4",
"prescribedById": 4,
"prescribedAt": datetime,
"expiresAt": datetime,
"labId": "4",
"xrayId": "4",
"vaccineId": "4",
"scheduledEvents": [ScheduledEventSchema],
"name": "abc123",
"unit": "ML",
"pricePerUnit": 123,
"instructions": "xyz789",
"adminFee": 123,
"minimumCharge": 123,
"qty": Decimal,
"customDoseUnit": "xyz789",
"route": "ORAL",
"freq": "xyz789",
"duration": 987,
"durUnit": "MINUTES",
"refills": 987,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"rxScriptId": 4,
"dischargeDocumentIds": ["4"],
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"clinicCostPerUnit": 123,
"parentBundleInfo": ParentBundleInfoSchema,
"dose": Decimal,
"createdAt": datetime
}
PrescribedTreatmentUpdateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID
|
|
qty - Decimal!
|
|
instanceId - ID!
|
|
name - String
|
|
unit - UnitEnum
|
|
pricePerUnit - Int
|
|
adminFee - Int
|
|
minimumCharge - Int
|
|
declined - Boolean
|
|
createdAt - String
|
|
instructions - String
|
|
dose - Decimal
|
|
customDoseUnit - String
|
|
route - MedRouteEnum
|
|
freq - String
|
|
duration - Int
|
|
durUnit - DurationUnitEnum
|
|
refills - Int
|
|
beforeDatetime - datetime
|
|
fulfill - PrescriptionFulfillEnum
|
|
labId - ID
|
|
xrayId - ID
|
|
vaccineId - ID
|
|
markupFactor - Decimal
|
|
priceType - PriceTypeEnum
|
|
scheduledEvents - [ScheduledEventUpdateSchema!]
|
|
rxScriptId - ID
|
|
filledById - ID
|
|
prescribedById - ID
|
|
prescribedAt - datetime
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
isDiscountable - Boolean
|
|
expiresAt - datetime
|
|
dischargeDocumentIds - [ID!]
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
clinicCostPerUnit - Int
|
|
parentBundleInfo - ParentBundleInfoCreateSchema
|
Example
{
"treatmentId": "4",
"qty": Decimal,
"instanceId": 4,
"name": "xyz789",
"unit": "ML",
"pricePerUnit": 123,
"adminFee": 987,
"minimumCharge": 123,
"declined": true,
"createdAt": "xyz789",
"instructions": "xyz789",
"dose": Decimal,
"customDoseUnit": "abc123",
"route": "ORAL",
"freq": "xyz789",
"duration": 987,
"durUnit": "MINUTES",
"refills": 987,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"labId": "4",
"xrayId": "4",
"vaccineId": 4,
"markupFactor": Decimal,
"priceType": "FIXED",
"scheduledEvents": [ScheduledEventUpdateSchema],
"rxScriptId": "4",
"filledById": "4",
"prescribedById": 4,
"prescribedAt": datetime,
"isTaxable": true,
"isPstTaxable": false,
"isDiscountable": true,
"expiresAt": datetime,
"dischargeDocumentIds": ["4"],
"isCustomTreatment": true,
"customTreatmentIsRxScript": false,
"clinicCostPerUnit": 123,
"parentBundleInfo": ParentBundleInfoCreateSchema
}
PrescriptionFillSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
vetcoveId - Int
|
Vetcove ID for the prescription filled |
units - Float
|
Number of units filled |
isPrn - Boolean
|
Whether this is a PRN (as needed) prescription |
itemName - String
|
Name of the medication/item filled |
directions - String
|
Directions for use |
issueDate - datetime
|
Date when prescription was issued |
patientName - String
|
Name of the patient |
clientId - String
|
ID of the client |
patientId - String
|
ID of the patient |
expirationDate - datetime
|
Expiration date of the medication |
prescriberName - String
|
Name of the prescribing veterinarian |
unitMeasurement - String
|
Unit of measurement (e.g., tablet, ml) |
quantityPerFill - Int
|
Quantity per fill |
inventoryItemBamId - String
|
Inventory item BAM ID |
remainingRefillsDisplay - String
|
Display text for remaining refills |
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "4",
"vetcoveId": 987,
"units": 123.45,
"isPrn": false,
"itemName": "abc123",
"directions": "abc123",
"issueDate": datetime,
"patientName": "xyz789",
"clientId": "abc123",
"patientId": "xyz789",
"expirationDate": datetime,
"prescriberName": "xyz789",
"unitMeasurement": "xyz789",
"quantityPerFill": 123,
"inventoryItemBamId": "xyz789",
"remainingRefillsDisplay": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
PrescriptionFulfillEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"IN_HOUSE"
PrescriptionOptionsSchema
PrescriptionOptionsUpdateSchema
PrescriptionOrderItemSchema
Fields
| Field Name | Description |
|---|---|
vetcoveId - Int
|
|
tax - Int
|
|
total - Int
|
|
units - Int
|
|
discount - Int
|
|
quantity - Int
|
|
shipping - Int
|
|
subtotal - Int
|
|
itemName - String
|
|
isCanceled - Boolean
|
|
handlingFee - Int
|
|
patientName - String
|
|
patientId - String
|
|
fulfillmentType - String
|
|
unitMeasurement - String
|
|
normalizedQuantity - Int
|
Example
{
"vetcoveId": 123,
"tax": 123,
"total": 987,
"units": 987,
"discount": 123,
"quantity": 123,
"shipping": 123,
"subtotal": 987,
"itemName": "xyz789",
"isCanceled": true,
"handlingFee": 987,
"patientName": "xyz789",
"patientId": "xyz789",
"fulfillmentType": "xyz789",
"unitMeasurement": "abc123",
"normalizedQuantity": 123
}
PrescriptionOrderSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
vetcoveId - Int
|
|
tax - Int
|
|
total - Int
|
|
discount - Int
|
|
shipping - Int
|
|
subtotal - Int
|
|
orderItems - [PrescriptionOrderItemSchema!]
|
|
serviceFee - Int
|
|
timePlaced - datetime
|
|
urgencyFee - Int
|
|
clientId - String
|
|
clientIds - [String!]
|
|
processingFee - Int
|
|
shippingAddressId - String
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "4",
"vetcoveId": 123,
"tax": 123,
"total": 987,
"discount": 987,
"shipping": 123,
"subtotal": 987,
"orderItems": [PrescriptionOrderItemSchema],
"serviceFee": 987,
"timePlaced": datetime,
"urgencyFee": 123,
"clientId": "abc123",
"clientIds": ["abc123"],
"processingFee": 123,
"shippingAddressId": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
PriceTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIXED"
Priority
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"URGENT"
ProcessAudioAndCreateVisitNoteInput
ProcessUploadedAudioFileRequest
PromptSchema
Fields
| Field Name | Description |
|---|---|
type - PromptType!
|
|
content - String!
|
Example
{
"type": "TRANSCRIPT_TO_SOAP",
"content": "abc123"
}
PromptType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TRANSCRIPT_TO_SOAP"
PromptUpdateSchema
Fields
| Input Field | Description |
|---|---|
type - PromptType!
|
|
content - String!
|
Example
{
"type": "TRANSCRIPT_TO_SOAP",
"content": "abc123"
}
ProviderCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ER"
PublicClinicUserSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
firstName - String!
|
|
lastName - String!
|
|
employeeInfo - PublicEmployeeInfoSchema
|
Example
{
"id": 4,
"firstName": "xyz789",
"lastName": "xyz789",
"employeeInfo": PublicEmployeeInfoSchema
}
PublicEmployeeInfoSchema
Fields
| Field Name | Description |
|---|---|
jobTitle - JobTitle
|
|
employeeStatus - UserStatus
|
|
providerCodes - [ProviderCode!]
|
|
mangoExtension - String
|
Example
{
"jobTitle": "OWNER",
"employeeStatus": "ACTIVE",
"providerCodes": ["ER"],
"mangoExtension": "xyz789"
}
PublicSettingsSchema
Fields
| Field Name | Description |
|---|---|
appointmentTypes - [AppointmentTypeSchema!]!
|
|
dbName - String!
|
|
clinicLogo - MediaSchema
|
|
twilioPhone - String
|
|
featureFlags - [FeatureFlagSchema!]!
|
|
street - String
|
Street address of the clinic location. Used for client communications and service area determination |
city - String
|
City where the clinic is located. Used for geographic services and client communications |
state - String
|
State or province where the clinic is located. Used for tax calculations and regulatory compliance |
country - String
|
Country where the clinic is located. Affects tax calculations, regulations, and feature availability |
zipCode - String
|
Postal or ZIP code for the clinic location. Used for geographic services and delivery logistics |
name - String!
|
The display name of the veterinary clinic - required for clinic identification. Used throughout the application for branding and display purposes |
email - String!
|
Primary contact email for the clinic - required and must be unique across all clinics. Used for system notifications, client communications, and authentication. Enforced as unique in database indexes |
phone - String!
|
Primary clinic phone number - required, must be 10-15 digits. Used for client communications and appointment confirmations. Enforced as unique in database indexes |
timezone - String!
|
Timezone for the clinic location - affects all datetime displays and scheduling logic. Must be a valid pytz timezone string, used by SettingsService.tz() for timezone conversion |
clinicLogoMediaId - String
|
Reference to uploaded clinic logo media file (Media model). Used for invoice headers, client portal branding, and document generation |
clientPortalOptions - ClientPortalOptions
|
Client portal configuration including medical record visibility and prescription refill workflows. Controls which medical records are visible to clients and automatic task creation for refill requests. rx_refill_task_default_creator and rx_refill_task_default_assignee reference User model IDs |
directOnlineSchedulingOptions - DirectOnlineSchedulingOptionsSchema
|
Online appointment scheduling configuration for client self-service. Controls availability windows, approval requirements, and species restrictions. species_allowed contains SpeciesEnum values that can book online |
prescriptionOptions - PrescriptionOptionsSchema
|
Prescription management feature toggles. Controls UI shortcuts and automatic signature generation for prescriptions |
createdAt - String
|
|
updatedAt - String
|
|
maintenanceMode - Boolean
|
Enables maintenance mode which restricts normal clinic operations. When true, prevents most user interactions and displays maintenance message |
enableSso - Boolean
|
Whether to enable SSO for the clinic |
ipRestrictionEnabled - Boolean
|
Whether IP restrictions are enabled for the entire clinic |
clinicIpAddress - String
|
IP address that is allowed to access the clinic |
Example
{
"appointmentTypes": [AppointmentTypeSchema],
"dbName": "xyz789",
"clinicLogo": MediaSchema,
"twilioPhone": "abc123",
"featureFlags": [FeatureFlagSchema],
"street": "xyz789",
"city": "abc123",
"state": "abc123",
"country": "xyz789",
"zipCode": "abc123",
"name": "xyz789",
"email": "abc123",
"phone": "xyz789",
"timezone": "xyz789",
"clinicLogoMediaId": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"maintenanceMode": false,
"enableSso": false,
"ipRestrictionEnabled": true,
"clinicIpAddress": "abc123"
}
PurchaseOrderCreateSchema
Fields
| Input Field | Description |
|---|---|
vetcoveId - Int
|
Vetcove's internal ID for this purchase order. Default = null |
creatorUid - ID
|
Reference to the clinic user who created this PO (ClinicUser model). Default = null |
poNumber - String
|
Purchase order number for tracking and reference. Default = null |
subtotal - Int
|
Subtotal amount in integer cents before tax and shipping. Default = null |
tax - Int
|
Tax amount in integer cents. Default = null |
shipping - Int
|
Shipping cost in integer cents. Default = null |
total - Int
|
Total amount in integer cents (subtotal + tax + shipping). Auto-calculated from items' total_price in calculate_total() method. Default = null |
vendorId - ID
|
Reference to the vendor/supplier for this PO (Vendor model). Default = null |
items - [PurchaseOrderInventoryItemCreateSchema!]
|
List of items being ordered in this purchase order. Status is updated based on items' received_at and cancelled fields. Default = [] |
orderPlacementTime - datetime
|
When this order was placed with the vendor. Default = "2025-12-07T06:14:04.791490+00:00" |
Example
{
"vetcoveId": 987,
"creatorUid": "4",
"poNumber": "abc123",
"subtotal": 987,
"tax": 987,
"shipping": 123,
"total": 123,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemCreateSchema],
"orderPlacementTime": datetime
}
PurchaseOrderFilterSchema
Fields
| Input Field | Description |
|---|---|
total - IntFilter
|
|
poNumber - StrFilter
|
|
vendorId - ObjectIdFilter
|
|
orderPlacementTime - DateFilter
|
|
status - StrFilter
|
|
createdAt - StrFilter
|
|
deletedAt - StrFilter
|
Example
{
"total": IntFilter,
"poNumber": StrFilter,
"vendorId": ObjectIdFilter,
"orderPlacementTime": DateFilter,
"status": StrFilter,
"createdAt": StrFilter,
"deletedAt": StrFilter
}
PurchaseOrderInventoryItemCreateSchema
Fields
| Input Field | Description |
|---|---|
id - String
|
Identifier that can be converted to treatment_id if it's a valid ObjectId. Default = null |
name - String
|
|
sku - String
|
Stock keeping unit identifier. Default = null |
unitMeasurement - String
|
|
quantity - Decimal
|
Quantity being ordered in this purchase order. Multiplied by units field during processing if both are present. Default = null |
treatmentId - ID
|
Reference to the treatment this item represents (Treatment model). Set during PO processing if id field contains valid ObjectId. Default = null |
locationId - ID
|
Reference to storage location for this item. Default = null |
vetcoveItemId - Int
|
Vetcove's internal identifier for this item. Default = null |
unitPrice - Int
|
Price per unit in integer cents. Auto-calculated from total_price/quantity during PO processing. Default = null |
listPrice - Int
|
List price per unit in integer cents before any discounts. Default = null |
totalPrice - Int
|
Total price for this line item in integer cents. Used to calculate unit_price during PO processing. Default = null |
units - Decimal
|
Number of units per package/case. Multiplied with quantity to get final order amount. Default = null |
isLinked - Boolean
|
Whether this item is linked to an existing treatment in the system. Default = false |
packType - String
|
Type of packaging (case, box, individual, etc.). Default = null |
availabilityCode - String
|
Vendor availability status code. Default = null |
availabilityText - String
|
Human-readable availability status description. Default = null |
manufacturerName - String
|
Name of the manufacturer for this item. Default = null |
deletedAt - datetime
|
Soft delete timestamp - when this item was removed from the PO. Default = null |
receivedAt - datetime
|
When this item was actually received into inventory. Used to update PO status and create inventory items. Default = null |
cancelled - Boolean
|
Whether this item was cancelled and won't be received. Used in PO status calculation alongside received_at. Default = false |
expiredAt - datetime
|
Expiration date for this specific item/lot. Default = null |
inventoryItemId - ID
|
Reference to the inventory item created when this PO item is received. Default = null |
lotId - String
|
Lot identifier from the manufacturer. Default = null |
serialNo - String
|
Serial number for tracking. Default = null |
ndcNumber - String
|
National Drug Code for pharmaceutical products. Default = null |
Example
{
"id": "abc123",
"name": "xyz789",
"sku": "abc123",
"unitMeasurement": "xyz789",
"quantity": Decimal,
"treatmentId": 4,
"locationId": "4",
"vetcoveItemId": 987,
"unitPrice": 123,
"listPrice": 123,
"totalPrice": 123,
"units": Decimal,
"isLinked": false,
"packType": "xyz789",
"availabilityCode": "abc123",
"availabilityText": "abc123",
"manufacturerName": "abc123",
"deletedAt": datetime,
"receivedAt": datetime,
"cancelled": true,
"expiredAt": datetime,
"inventoryItemId": "4",
"lotId": "xyz789",
"serialNo": "abc123",
"ndcNumber": "abc123"
}
PurchaseOrderInventoryItemSchema
Fields
| Field Name | Description |
|---|---|
id - String
|
Identifier that can be converted to treatment_id if it's a valid ObjectId |
name - String
|
|
sku - String
|
Stock keeping unit identifier |
unitMeasurement - String
|
|
quantity - Decimal
|
Quantity being ordered in this purchase order. Multiplied by units field during processing if both are present |
treatmentId - ID
|
Reference to the treatment this item represents (Treatment model). Set during PO processing if id field contains valid ObjectId |
locationId - ID
|
Reference to storage location for this item |
vetcoveItemId - Int
|
Vetcove's internal identifier for this item |
unitPrice - Int
|
Price per unit in integer cents. Auto-calculated from total_price/quantity during PO processing |
listPrice - Int
|
List price per unit in integer cents before any discounts |
totalPrice - Int
|
Total price for this line item in integer cents. Used to calculate unit_price during PO processing |
units - Decimal
|
Number of units per package/case. Multiplied with quantity to get final order amount |
isLinked - Boolean
|
Whether this item is linked to an existing treatment in the system |
packType - String
|
Type of packaging (case, box, individual, etc.) |
availabilityCode - String
|
Vendor availability status code |
availabilityText - String
|
Human-readable availability status description |
manufacturerName - String
|
Name of the manufacturer for this item |
deletedAt - datetime
|
Soft delete timestamp - when this item was removed from the PO |
receivedAt - datetime
|
When this item was actually received into inventory. Used to update PO status and create inventory items |
cancelled - Boolean
|
Whether this item was cancelled and won't be received. Used in PO status calculation alongside received_at |
expiredAt - datetime
|
Expiration date for this specific item/lot |
inventoryItemId - ID
|
Reference to the inventory item created when this PO item is received |
lotId - String
|
Lot identifier from the manufacturer |
serialNo - String
|
Serial number for tracking |
ndcNumber - String
|
National Drug Code for pharmaceutical products |
Example
{
"id": "abc123",
"name": "abc123",
"sku": "xyz789",
"unitMeasurement": "abc123",
"quantity": Decimal,
"treatmentId": 4,
"locationId": "4",
"vetcoveItemId": 987,
"unitPrice": 987,
"listPrice": 987,
"totalPrice": 123,
"units": Decimal,
"isLinked": false,
"packType": "xyz789",
"availabilityCode": "xyz789",
"availabilityText": "xyz789",
"manufacturerName": "abc123",
"deletedAt": datetime,
"receivedAt": datetime,
"cancelled": true,
"expiredAt": datetime,
"inventoryItemId": 4,
"lotId": "xyz789",
"serialNo": "abc123",
"ndcNumber": "xyz789"
}
PurchaseOrderSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
vetcoveId - Int
|
Vetcove's internal ID for this purchase order |
creatorUid - ID
|
Reference to the clinic user who created this PO (ClinicUser model) |
poNumber - String
|
Purchase order number for tracking and reference |
subtotal - Int
|
Subtotal amount in integer cents before tax and shipping |
tax - Int
|
Tax amount in integer cents |
shipping - Int
|
Shipping cost in integer cents |
total - Int
|
Total amount in integer cents (subtotal + tax + shipping). Auto-calculated from items' total_price in calculate_total() method |
vendorId - ID
|
Reference to the vendor/supplier for this PO (Vendor model) |
items - [PurchaseOrderInventoryItemSchema!]
|
List of items being ordered in this purchase order. Status is updated based on items' received_at and cancelled fields |
orderPlacementTime - datetime
|
When this order was placed with the vendor |
status - PurchaseOrderStatus
|
Current status of the purchase order. Auto-updated via update_status() based on items received/cancelled status |
deletedAt - datetime
|
|
createdAt - datetime
|
|
updatedAt - datetime
|
Example
{
"id": 4,
"vetcoveId": 123,
"creatorUid": "4",
"poNumber": "xyz789",
"subtotal": 987,
"tax": 987,
"shipping": 123,
"total": 987,
"vendorId": "4",
"items": [PurchaseOrderInventoryItemSchema],
"orderPlacementTime": datetime,
"status": "DRAFT",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
PurchaseOrderSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PurchaseOrderSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [PurchaseOrderSchemaEdge]
}
PurchaseOrderSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - PurchaseOrderSchema!
|
|
cursor - String!
|
Example
{
"node": PurchaseOrderSchema,
"cursor": "xyz789"
}
PurchaseOrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
PurchaseOrderUpdateSchema
Example
{
"id": 4,
"vetcoveId": 123,
"poNumber": "xyz789",
"subtotal": 987,
"tax": 987,
"shipping": 123,
"total": 987,
"deletedAt": datetime,
"orderPlacementTime": datetime,
"creatorUid": 4,
"vendorId": 4,
"items": [PurchaseOrderInventoryItemCreateSchema],
"status": "DRAFT"
}
QueryOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASCENDING"
RecentDiagnosisViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
patientDotSpecies - StrFilter
|
|
patientDotBreed - StrFilter
|
|
isChronic - BoolFilter
|
|
createdAt - DateFilter
|
|
diagnosisName - StrFilter
|
|
assessmentDotDiagnosesDotName - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"patientDotSpecies": StrFilter,
"patientDotBreed": StrFilter,
"isChronic": BoolFilter,
"createdAt": DateFilter,
"diagnosisName": StrFilter,
"assessmentDotDiagnosesDotName": StrFilter
}
RecentDiagnosisViewSchema
Fields
| Field Name | Description |
|---|---|
ongoingDiagnosis - OngoingDiagnosisSchema
|
|
id - String!
|
|
soapId - ID!
|
|
createdAt - datetime!
|
|
patientId - ID!
|
|
diagnosisName - String!
|
|
diagnosis - DiagnosisEntrySchema!
|
|
patient - PatientSchema
|
|
isChronic - Boolean!
|
Example
{
"ongoingDiagnosis": OngoingDiagnosisSchema,
"id": "xyz789",
"soapId": 4,
"createdAt": datetime,
"patientId": 4,
"diagnosisName": "xyz789",
"diagnosis": DiagnosisEntrySchema,
"patient": PatientSchema,
"isChronic": true
}
RecentDiagnosisViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [RecentDiagnosisViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [RecentDiagnosisViewSchemaEdge]
}
RecentDiagnosisViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - RecentDiagnosisViewSchema!
|
|
cursor - String!
|
Example
{
"node": RecentDiagnosisViewSchema,
"cursor": "abc123"
}
ReconcileCashCreateSchema
RecordedSurgeryVitalSchema
Fields
| Field Name | Description |
|---|---|
values - [SurgeryVitalValueSchema!]!
|
List of vital sign measurements taken at a specific time |
createdAt - datetime!
|
Example
{
"values": [SurgeryVitalValueSchema],
"createdAt": datetime
}
RecordedSurgeryVitalUpdateSchema
Fields
| Input Field | Description |
|---|---|
values - [SurgeryVitalValueUpdateSchema!]!
|
Example
{"values": [SurgeryVitalValueUpdateSchema]}
RecordingSchema
RecordingUpdateSchema
ReminderCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
creatorUid - ID!
|
|
refId - ID!
|
|
dueDate - datetime!
|
|
status - ReminderStatusEnum
|
|
notes - String
|
|
type - ReminderTypeEnum
|
|
invoiceId - ID
|
Example
{
"patientId": "4",
"creatorUid": 4,
"refId": 4,
"dueDate": datetime,
"status": "ACTIVE",
"notes": "xyz789",
"type": "TREATMENT",
"invoiceId": "4"
}
ReminderDeleteSchema
Fields
| Input Field | Description |
|---|---|
reminderId - ID!
|
|
status - ReminderStatusEnum
|
Example
{"reminderId": "4", "status": "ACTIVE"}
ReminderSchema
Fields
| Field Name | Description |
|---|---|
patient - PatientSchema
|
|
client - ClinicUserSchema
|
|
treatment - TreatmentSchema
|
|
vaccine - VaccineSchema
|
|
isEmailable - Boolean!
|
|
isSmsable - Boolean!
|
|
reminderId - ID!
|
|
status - ReminderStatusEnum
|
Current status of the reminder - defaults to ACTIVE when created. When status changes to COMPLETED, reminder is considered fulfilled. Service layer prevents updates to COMPLETED or DELETED reminders. Status transitions: ACTIVE -> COMPLETED/INACTIVE/DELETED |
patientId - ID!
|
Reference to the patient this reminder is for (ClinicPatient model). Required field - reminder cannot exist without a valid patient. Indexed for efficient retrieval of patient's reminders. Patient must exist and be active when creating reminder |
refId - ID
|
Optional reference to related entity based on reminder type. For TREATMENT type: references Treatment model via treatment_id. Used to link reminder to specific treatments for tracking and completion. When treatment is administered via invoice, matching reminders are auto-completed. Indexed with due_date for efficient querying of treatment-specific reminders |
notes - String
|
Optional free-text notes for additional reminder context. Used to store custom instructions or details about the reminder. No validation constraints - can be any string content |
type - ReminderTypeEnum
|
Type of reminder - defaults to TREATMENT for medical follow-ups. TREATMENT type: linked to specific treatments via ref_id. OTHER type: general reminders not tied to specific treatments. Affects how reminder is processed and what related data is loaded |
creatorUid - ID!
|
Optional reference to employee who created the reminder (ClinicUser model). Used for audit trails and accountability. Must reference an ACTIVE user when provided during creation. Not required - system can create reminders automatically |
invoiceId - ID
|
|
dueDate - datetime
|
Date and time when the reminder is due. Required field - determines when reminder appears in upcoming lists. Used for filtering reminders by date ranges and scheduling notifications. Automatically calculated for treatment reminders based on relative_due_time |
createdAt - datetime
|
|
updatedAt - datetime
|
Example
{
"patient": PatientSchema,
"client": ClinicUserSchema,
"treatment": TreatmentSchema,
"vaccine": VaccineSchema,
"isEmailable": false,
"isSmsable": false,
"reminderId": 4,
"status": "ACTIVE",
"patientId": "4",
"refId": "4",
"notes": "xyz789",
"type": "TREATMENT",
"creatorUid": 4,
"invoiceId": "4",
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
ReminderSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DUE_DATE_ASC"
ReminderStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
ReminderTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TREATMENT"
ReminderUpdateSchema
Fields
| Input Field | Description |
|---|---|
reminderId - ID!
|
|
invoiceId - ID
|
|
status - ReminderStatusEnum
|
|
notes - String
|
|
type - ReminderTypeEnum
|
|
dueDate - datetime
|
Example
{
"reminderId": 4,
"invoiceId": "4",
"status": "ACTIVE",
"notes": "abc123",
"type": "TREATMENT",
"dueDate": datetime
}
ReminderViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
clientId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
|
dueDate - DateFilter
|
|
treatmentId - ListObjectIdFilter
|
|
treatmentDotName - StrFilter
|
|
patientDotSpecies - StrFilter
|
|
patientDotBreed - StrFilter
|
|
patientDotDateOfBirth - DateFilter
|
Example
{
"patientId": ListObjectIdFilter,
"clientId": ListObjectIdFilter,
"createdAt": DateFilter,
"dueDate": DateFilter,
"treatmentId": ListObjectIdFilter,
"treatmentDotName": StrFilter,
"patientDotSpecies": StrFilter,
"patientDotBreed": StrFilter,
"patientDotDateOfBirth": DateFilter
}
ReminderViewSchema
Fields
| Field Name | Description |
|---|---|
clientId - ID!
|
|
id - ID!
|
|
reminderId - ID!
|
|
status - ReminderStatusEnum
|
|
patientId - ID!
|
|
notes - String
|
|
refId - ID
|
|
type - ReminderTypeEnum
|
|
creatorUid - ID!
|
|
invoiceId - ID
|
|
lastAppointmentDate - datetime
|
Calculated field - latest appointment date for the patient. Populated via aggregation pipeline from appointments collection. Used to provide context about patient's recent visit history. Helps determine if reminder is overdue relative to last visit |
dueDate - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
patient - PatientSchema
|
Populated via aggregation pipeline - full patient record (ClinicPatient model). Required relationship - provides patient details for reminder display. Joined from clinic_patients collection using patient_id |
treatment - TreatmentSchema
|
Optional treatment details when reminder type is TREATMENT (Treatment model). Populated via lookup from treatments collection using ref_id. Only present for TREATMENT type reminders with valid ref_id. Unwound in pipeline so only active reminders with treatments are returned |
client - ClinicUserSchema
|
Client information from primary family contact (ClinicUser model). Populated via family relationship - patient -> family -> primary_contact_uid. Used for client communication and contact details. Required for reminder notifications and client portal display |
family - FamilySchema
|
Family record containing the patient (Family model). Populated via lookup from families collection where patient_id in patients array. Used to access family-level information and primary contact details. Required relationship - patients must belong to a family |
Example
{
"clientId": "4",
"id": 4,
"reminderId": "4",
"status": "ACTIVE",
"patientId": 4,
"notes": "abc123",
"refId": 4,
"type": "TREATMENT",
"creatorUid": "4",
"invoiceId": "4",
"lastAppointmentDate": datetime,
"dueDate": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"patient": PatientSchema,
"treatment": TreatmentSchema,
"client": ClinicUserSchema,
"family": FamilySchema
}
ReminderViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ReminderViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [ReminderViewSchemaEdge]
}
ReminderViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - ReminderViewSchema!
|
|
cursor - String!
|
Example
{
"node": ReminderViewSchema,
"cursor": "abc123"
}
RemoveFutureScheduledEventsSchema
ReportQueryFilter
RequestRefillSchema
ResetPasswordSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
ResourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PATIENT"
ResourceTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLINIC_USER"
ResumeSubscriptionInput
Fields
| Input Field | Description |
|---|---|
subscriptionId - String!
|
Example
{"subscriptionId": "abc123"}
RevenueReportItemSchema
Fields
| Field Name | Description |
|---|---|
invoiceId - String!
|
|
grossRevenue - Int!
|
|
discount - Int!
|
|
voidedAmount - Int!
|
|
netRevenue - Int!
|
|
qty - Decimal!
|
|
providerId - String!
|
|
treatmentId - String!
|
|
treatmentName - String
|
|
providerName - String
|
|
typeCode - String
|
|
type - String
|
|
categoryCode - String
|
|
category - String
|
|
invoicedAt - datetime!
|
|
medicalNoteId - String
|
|
medicalNoteType - NoteType
|
Example
{
"invoiceId": "abc123",
"grossRevenue": 123,
"discount": 987,
"voidedAmount": 123,
"netRevenue": 987,
"qty": Decimal,
"providerId": "abc123",
"treatmentId": "abc123",
"treatmentName": "xyz789",
"providerName": "abc123",
"typeCode": "abc123",
"type": "abc123",
"categoryCode": "abc123",
"category": "abc123",
"invoicedAt": datetime,
"medicalNoteId": "xyz789",
"medicalNoteType": "SOAP"
}
RevenueReportSchema
Fields
| Field Name | Description |
|---|---|
providerTotals - [NamedTotalSchema!]!
|
|
treatmentTotals - [NamedTotalSchema!]!
|
|
typeCodeTotals - [NamedTotalSchema!]!
|
|
categoryCodeTotals - [NamedTotalSchema!]!
|
|
appointmentTypeTotals - [NamedTotalSchema!]!
|
|
monthlyTotals - [NamedTotalSchema!]!
|
|
yearlyTotals - [NamedTotalSchema!]!
|
|
revenueReportItems - [RevenueReportItemSchema!]!
|
Example
{
"providerTotals": [NamedTotalSchema],
"treatmentTotals": [NamedTotalSchema],
"typeCodeTotals": [NamedTotalSchema],
"categoryCodeTotals": [NamedTotalSchema],
"appointmentTypeTotals": [NamedTotalSchema],
"monthlyTotals": [NamedTotalSchema],
"yearlyTotals": [NamedTotalSchema],
"revenueReportItems": [RevenueReportItemSchema]
}
ReverseAcceptNonLinkedPurchaseOrderItemSchema
ReverseInventoryItemFromPurchaseOrderCreateSchema
Role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GUEST"
RoleCreateSchema
RoleDeleteSchema
RoleSchema
Example
{
"id": 4,
"name": "xyz789",
"permissions": ["xyz789"],
"systemRole": false,
"sisterClinics": ["abc123"],
"createdAt": datetime,
"updatedAt": datetime
}
RoleUpdateSchema
RxScriptCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
creatorUid - ID
|
|
clientId - ID!
|
|
refId - ID
|
|
originalRefId - ID
|
|
renewedRefId - ID
|
|
renewedFromRefId - ID
|
|
treatmentId - ID
|
|
treatmentInstanceId - ID
|
|
treatment - String!
|
|
totalDosage - Decimal!
|
|
customDoseUnit - String
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
duration - Int!
|
|
durationUnit - DurationUnitEnum!
|
|
refills - Int!
|
|
instructions - String
|
|
voided - Boolean
|
|
beginsAt - datetime!
|
|
expiresAt - datetime!
|
|
beforeDatetime - datetime!
|
Example
{
"patientId": "4",
"creatorUid": 4,
"clientId": 4,
"refId": 4,
"originalRefId": "4",
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": "4",
"treatmentInstanceId": "4",
"treatment": "abc123",
"totalDosage": Decimal,
"customDoseUnit": "xyz789",
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"duration": 123,
"durationUnit": "MINUTES",
"refills": 123,
"instructions": "xyz789",
"voided": true,
"beginsAt": datetime,
"expiresAt": datetime,
"beforeDatetime": datetime
}
RxScriptFillSchema
Example
{
"rxScriptId": "4",
"filledById": "4",
"expiresAt": datetime,
"beforeDatetime": datetime,
"invoiceId": "4",
"noteId": "4",
"noteType": "SOAP"
}
RxScriptFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
clientId - ListObjectIdFilter
|
|
filledById - ListObjectIdFilter
|
|
refills - DecimalFilter
|
|
voided - BoolFilter
|
|
treatment - StrFilter
|
|
beginsAt - DateFilter
|
|
expiresAt - DateFilter
|
|
createdAt - DateFilter
|
Example
{
"patientId": ListObjectIdFilter,
"clientId": ListObjectIdFilter,
"filledById": ListObjectIdFilter,
"refills": DecimalFilter,
"voided": BoolFilter,
"treatment": StrFilter,
"beginsAt": DateFilter,
"expiresAt": DateFilter,
"createdAt": DateFilter
}
RxScriptOriginalSchema
Fields
| Field Name | Description |
|---|---|
treatmentobj - TreatmentSchema
|
|
rxScriptId - ID!
|
|
patientId - ID!
|
Required reference to the patient receiving this prescription (ClinicPatient). Validated in RxScriptService.create_rx_script() to ensure patient exists |
creatorUid - ID
|
Optional reference to the clinic user who created this prescription (ClinicUser). If provided, validated in RxScriptService.create_rx_script() to ensure user exists |
filledById - ID
|
Optional reference to the clinic user who filled/dispensed this prescription (ClinicUser). When set, triggers invoice creation for refills in RxScriptService.create_rx_script() |
clientId - ID!
|
Required reference to the client/owner of the patient (ClinicUser). May be updated during refills if patient has been transferred to new family |
refId - ID
|
Reference to the prescription this is a refill of (RxScript). Set when filling an existing prescription, points to the most recent script in the chain |
originalRefId - ID
|
Reference to the original prescription in a refill chain (RxScript). All refills in a chain share this same original_ref_id for tracking purposes. Used to find most recent refill and validate refill eligibility |
renewedRefId - ID
|
Reference to the prescription this was renewed to (RxScript). Set when a prescription is renewed, prevents multiple renewals of same script. Cleared when voiding a renewed prescription to allow re-voiding |
treatmentId - ID
|
Optional reference to the treatment template used (Treatment). When present, used for invoice creation with treatment pricing and admin fees |
treatment - String!
|
Required name/description of the medication or treatment. Used in display strings and patient history records |
totalDosage - Decimal!
|
Required total dosage amount as decimal value. Used for invoice quantity calculation when creating invoices for filled prescriptions |
duration - Int!
|
Duration for how long the prescription should be taken (defaults to 0). Must be used with duration_unit to specify complete duration |
durationUnit - DurationUnitEnum!
|
Required unit for the duration (DurationUnitEnum: days, weeks, months, etc.). Works in conjunction with duration field to specify treatment length |
customDoseUnit - String
|
Optional custom unit for dosage when standard units don't apply. Allows flexibility for specialized treatments or custom dosing instructions |
isCustomTreatment - Boolean
|
Flag indicating if this is a custom treatment not from standard templates. Affects how the prescription is processed and displayed |
customTreatmentIsRxScript - Boolean
|
Flag indicating if this custom treatment is an RX script. Defaults to True for custom treatments. |
refills - Int!
|
Number of refills remaining (defaults to 0). Decremented by 1 each time prescription is filled, prevents filling when 0 |
instructions - String
|
Optional free-text instructions for taking the medication. Displayed to clients and used in prescription documentation |
voided - Boolean!
|
Flag indicating if this prescription has been voided/cancelled. When set to True, creates patient history entry and may clear renewed_ref_id |
voidReason - String
|
Optional reason for voiding the prescription. Required to be provided when voiding through RxScriptService.void_rx_script() |
beginsAt - datetime!
|
Required start date/time when prescription becomes valid. Must be before expires_at, validated in RxScriptService.validate_date_range() |
expiresAt - datetime!
|
Required end date/time when prescription expires. Must be after begins_at, validated in RxScriptService.validate_date_range() |
updatedAt - datetime!
|
|
createdAt - datetime!
|
|
beforeDatetime - datetime
|
Optional datetime constraint for when prescription should be taken/filled before. Used in prescription filling workflows to specify time-sensitive requirements |
Example
{
"treatmentobj": TreatmentSchema,
"rxScriptId": 4,
"patientId": 4,
"creatorUid": 4,
"filledById": 4,
"clientId": "4",
"refId": "4",
"originalRefId": 4,
"renewedRefId": 4,
"treatmentId": "4",
"treatment": "abc123",
"totalDosage": Decimal,
"duration": 123,
"durationUnit": "MINUTES",
"customDoseUnit": "abc123",
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"refills": 987,
"instructions": "abc123",
"voided": false,
"voidReason": "xyz789",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
RxScriptRealUpdateSchema
Fields
| Input Field | Description |
|---|---|
rxScriptId - ID!
|
|
patientId - ID
|
|
creatorUid - ID
|
|
clientId - ID
|
|
refId - ID
|
|
originalRefId - ID
|
|
renewedRefId - ID
|
|
renewedFromRefId - ID
|
|
treatmentId - ID
|
|
treatmentInstanceId - ID
|
|
treatment - String
|
|
totalDosage - Decimal
|
|
customDoseUnit - String
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
duration - Int
|
|
durationUnit - DurationUnitEnum
|
|
refills - Int
|
|
instructions - String
|
|
voided - Boolean
|
|
beginsAt - datetime
|
|
expiresAt - datetime
|
|
beforeDatetime - datetime
|
Example
{
"rxScriptId": 4,
"patientId": "4",
"creatorUid": 4,
"clientId": "4",
"refId": 4,
"originalRefId": 4,
"renewedRefId": "4",
"renewedFromRefId": "4",
"treatmentId": 4,
"treatmentInstanceId": "4",
"treatment": "xyz789",
"totalDosage": Decimal,
"customDoseUnit": "abc123",
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"duration": 987,
"durationUnit": "MINUTES",
"refills": 987,
"instructions": "xyz789",
"voided": true,
"beginsAt": datetime,
"expiresAt": datetime,
"beforeDatetime": datetime
}
RxScriptRenewSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
|
creatorUid - ID
|
|
clientId - ID!
|
|
refId - ID
|
|
originalRefId - ID
|
|
renewedRefId - ID
|
|
renewedFromRefId - ID
|
|
treatmentId - ID
|
|
treatmentInstanceId - ID
|
|
treatment - String!
|
|
totalDosage - Decimal!
|
|
customDoseUnit - String
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
duration - Int!
|
|
durationUnit - DurationUnitEnum!
|
|
refills - Int!
|
|
instructions - String
|
|
voided - Boolean
|
|
beginsAt - datetime!
|
|
expiresAt - datetime!
|
|
beforeDatetime - datetime!
|
|
rxScriptId - ID!
|
Example
{
"patientId": 4,
"creatorUid": 4,
"clientId": "4",
"refId": "4",
"originalRefId": 4,
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": "4",
"treatmentInstanceId": 4,
"treatment": "abc123",
"totalDosage": Decimal,
"customDoseUnit": "abc123",
"isCustomTreatment": false,
"customTreatmentIsRxScript": true,
"duration": 123,
"durationUnit": "MINUTES",
"refills": 123,
"instructions": "abc123",
"voided": true,
"beginsAt": datetime,
"expiresAt": datetime,
"beforeDatetime": datetime,
"rxScriptId": "4"
}
RxScriptSchema
Fields
| Field Name | Description |
|---|---|
originalRxScript - RxScriptOriginalSchema
|
|
mostRecentRefill - RxScriptOriginalSchema
|
|
treatmentobj - TreatmentSchema
|
|
rxScriptId - ID!
|
|
patientId - ID!
|
Required reference to the patient receiving this prescription (ClinicPatient). Validated in RxScriptService.create_rx_script() to ensure patient exists |
creatorUid - ID
|
Optional reference to the clinic user who created this prescription (ClinicUser). If provided, validated in RxScriptService.create_rx_script() to ensure user exists |
filledById - ID
|
Optional reference to the clinic user who filled/dispensed this prescription (ClinicUser). When set, triggers invoice creation for refills in RxScriptService.create_rx_script() |
clientId - ID!
|
Required reference to the client/owner of the patient (ClinicUser). May be updated during refills if patient has been transferred to new family |
refId - ID
|
Reference to the prescription this is a refill of (RxScript). Set when filling an existing prescription, points to the most recent script in the chain |
originalRefId - ID
|
Reference to the original prescription in a refill chain (RxScript). All refills in a chain share this same original_ref_id for tracking purposes. Used to find most recent refill and validate refill eligibility |
renewedRefId - ID
|
Reference to the prescription this was renewed to (RxScript). Set when a prescription is renewed, prevents multiple renewals of same script. Cleared when voiding a renewed prescription to allow re-voiding |
renewedFromRefId - ID
|
|
treatmentId - ID
|
Optional reference to the treatment template used (Treatment). When present, used for invoice creation with treatment pricing and admin fees |
treatmentInstanceId - ID
|
|
treatment - String!
|
Required name/description of the medication or treatment. Used in display strings and patient history records |
totalDosage - Decimal!
|
Required total dosage amount as decimal value. Used for invoice quantity calculation when creating invoices for filled prescriptions |
duration - Int!
|
Duration for how long the prescription should be taken (defaults to 0). Must be used with duration_unit to specify complete duration |
durationUnit - DurationUnitEnum!
|
Required unit for the duration (DurationUnitEnum: days, weeks, months, etc.). Works in conjunction with duration field to specify treatment length |
customDoseUnit - String
|
Optional custom unit for dosage when standard units don't apply. Allows flexibility for specialized treatments or custom dosing instructions |
isCustomTreatment - Boolean
|
Flag indicating if this is a custom treatment not from standard templates. Affects how the prescription is processed and displayed |
customTreatmentIsRxScript - Boolean
|
Flag indicating if this custom treatment is an RX script. Defaults to True for custom treatments. |
refills - Int!
|
Number of refills remaining (defaults to 0). Decremented by 1 each time prescription is filled, prevents filling when 0 |
instructions - String
|
Optional free-text instructions for taking the medication. Displayed to clients and used in prescription documentation |
voided - Boolean!
|
Flag indicating if this prescription has been voided/cancelled. When set to True, creates patient history entry and may clear renewed_ref_id |
voidReason - String
|
Optional reason for voiding the prescription. Required to be provided when voiding through RxScriptService.void_rx_script() |
beginsAt - datetime!
|
Required start date/time when prescription becomes valid. Must be before expires_at, validated in RxScriptService.validate_date_range() |
expiresAt - datetime!
|
Required end date/time when prescription expires. Must be after begins_at, validated in RxScriptService.validate_date_range() |
updatedAt - datetime!
|
|
createdAt - datetime!
|
|
beforeDatetime - datetime
|
Optional datetime constraint for when prescription should be taken/filled before. Used in prescription filling workflows to specify time-sensitive requirements |
Example
{
"originalRxScript": RxScriptOriginalSchema,
"mostRecentRefill": RxScriptOriginalSchema,
"treatmentobj": TreatmentSchema,
"rxScriptId": "4",
"patientId": "4",
"creatorUid": 4,
"filledById": "4",
"clientId": "4",
"refId": 4,
"originalRefId": 4,
"renewedRefId": 4,
"renewedFromRefId": "4",
"treatmentId": 4,
"treatmentInstanceId": "4",
"treatment": "xyz789",
"totalDosage": Decimal,
"duration": 123,
"durationUnit": "MINUTES",
"customDoseUnit": "xyz789",
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"refills": 987,
"instructions": "abc123",
"voided": false,
"voidReason": "abc123",
"beginsAt": datetime,
"expiresAt": datetime,
"updatedAt": datetime,
"createdAt": datetime,
"beforeDatetime": datetime
}
RxScriptTodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
treatmentName - String!
|
Display name of the pharmacy treatment from the Treatment model. Used to identify which prescription needs to be written |
rxScriptId - ID
|
Reference to created prescription record (RxScript model). Populated when prescription is generated, indicates completion |
soapId - ID
|
Reference to the medical record (Soap model) requiring this prescription. Mutually exclusive with surgery_id - only one should be set |
surgeryId - ID
|
Reference to the surgery record (Surgery model) requiring this prescription. Mutually exclusive with soap_id - only one should be set |
Example
{
"id": 4,
"completed": true,
"todoType": "VACCINE_CERTIFICATE",
"treatmentName": "abc123",
"rxScriptId": 4,
"soapId": "4",
"surgeryId": 4
}
RxScriptUpdateSchema
RxScriptViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
rxScriptId - ID!
|
|
patientId - ID!
|
|
clientId - ID!
|
|
totalDosage - Decimal!
|
|
durationUnit - String!
|
|
customDoseUnit - String
|
|
isCustomTreatment - Boolean
|
|
customTreatmentIsRxScript - Boolean
|
|
beginsAt - datetime!
|
|
expiresAt - datetime!
|
|
refills - Int!
|
|
duration - Int!
|
|
voided - Boolean!
|
|
treatment - String!
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
instructions - String
|
|
creatorUid - ID
|
|
filledById - ID
|
|
refId - ID
|
|
patient - PatientSchema
|
|
provider - ClinicUserSchema
|
|
client - ClinicUserSchema
|
|
patientFirstNameLowercase - String
|
|
clientLastNameLowercase - String
|
|
originalRefId - ID
|
|
renewedRefId - ID
|
|
renewedFromRefId - ID
|
|
treatmentId - ID
|
|
providerLastNameLowercase - String
|
|
originalRxScript - RxScriptSchema
|
|
mostRecentRefill - RxScriptSchema
|
Example
{
"id": "4",
"rxScriptId": 4,
"patientId": 4,
"clientId": "4",
"totalDosage": Decimal,
"durationUnit": "xyz789",
"customDoseUnit": "abc123",
"isCustomTreatment": true,
"customTreatmentIsRxScript": true,
"beginsAt": datetime,
"expiresAt": datetime,
"refills": 123,
"duration": 123,
"voided": true,
"treatment": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"instructions": "xyz789",
"creatorUid": "4",
"filledById": "4",
"refId": 4,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"patientFirstNameLowercase": "abc123",
"clientLastNameLowercase": "xyz789",
"originalRefId": "4",
"renewedRefId": "4",
"renewedFromRefId": 4,
"treatmentId": "4",
"providerLastNameLowercase": "abc123",
"originalRxScript": RxScriptSchema,
"mostRecentRefill": RxScriptSchema
}
RxScriptViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [RxScriptViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [RxScriptViewSchemaEdge]
}
RxScriptViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - RxScriptViewSchema!
|
|
cursor - String!
|
Example
{
"node": RxScriptViewSchema,
"cursor": "abc123"
}
RxScriptVoidSchema
SMSTemplateCreateSchema
SMSTemplateSchema
Example
{
"availableVariables": {},
"id": 4,
"name": "xyz789",
"description": "xyz789",
"templateKey": "xyz789",
"body": "abc123",
"type": "AUTOMATED",
"linkedFormIds": [4],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime
}
SMSTemplateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AUTOMATED"
SMSTemplateUpdateSchema
SaveMessagesToPatientHistorySinceLastSaveMutationResponse
Fields
| Field Name | Description |
|---|---|
conversation - ConversationSchema!
|
|
patientHistoryItem - PatientHistoryItemSchema!
|
Example
{
"conversation": ConversationSchema,
"patientHistoryItem": PatientHistoryItemSchema
}
ScheduleChangeSchema
Example
{
"mutation": "xyz789",
"creatorUid": 4,
"scheduleId": 4,
"type": "WORK_HOURS",
"employeeUid": 4,
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": false,
"rrule": "xyz789",
"onlineBookingConfig": OnlineBookingConfigUpdateSchema,
"scheduleIdsToIgnore": [4]
}
ScheduleFollowUpTodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
beforeDatetime - datetime
|
Deadline for scheduling the follow-up appointment. Derived from follow_ups array in Soap/Surgery models. Indicates when the follow-up should be scheduled by (not the appointment date itself) |
Example
{
"id": 4,
"completed": false,
"todoType": "VACCINE_CERTIFICATE",
"beforeDatetime": datetime
}
ScheduleSchema
Example
{
"scheduleId": 4,
"type": "WORK_HOURS",
"creatorUid": 4,
"employeeUid": "4",
"startDatetime": datetime,
"endDatetime": datetime,
"fullDay": false,
"rrule": "xyz789",
"onlineBookingConfig": OnlineBookingConfigSchema,
"createdAt": datetime,
"updatedAt": datetime
}
ScheduleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WORK_HOURS"
ScheduledEventCreateSchema
Fields
| Input Field | Description |
|---|---|
startDatetime - datetime
|
When the scheduled event should begin. Default = null |
endDatetime - datetime
|
When the scheduled event should end. Default = null |
status - ScheduledEventStatus!
|
Current status of the scheduled event (scheduled or completed). Default = SCHEDULED |
instructions - String
|
Special instructions for this scheduled event. Default = null |
type - ScheduledEventType!
|
Whether this is a scheduled event or can be done anytime. Default = SCHEDULED |
doneAt - datetime
|
Timestamp when the event was marked as completed. Default = null |
doneBy - ID
|
Reference to user who completed the event (ClinicUser model). Default = null |
Example
{
"startDatetime": datetime,
"endDatetime": datetime,
"status": "SCHEDULED",
"instructions": "xyz789",
"type": "SCHEDULED",
"doneAt": datetime,
"doneBy": "4"
}
ScheduledEventSchema
Fields
| Field Name | Description |
|---|---|
startDatetime - datetime
|
|
endDatetime - datetime
|
|
status - ScheduledEventStatus!
|
|
instructions - String
|
|
doneAt - datetime
|
|
doneBy - ID
|
|
type - ScheduledEventType!
|
Example
{
"startDatetime": datetime,
"endDatetime": datetime,
"status": "SCHEDULED",
"instructions": "abc123",
"doneAt": datetime,
"doneBy": "4",
"type": "SCHEDULED"
}
ScheduledEventStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SCHEDULED"
ScheduledEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SCHEDULED"
ScheduledEventUpdateSchema
Fields
| Input Field | Description |
|---|---|
startDatetime - datetime
|
|
endDatetime - datetime
|
|
status - ScheduledEventStatus
|
|
instructions - String
|
|
type - ScheduledEventType
|
|
doneAt - datetime
|
|
doneBy - ID
|
Example
{
"startDatetime": datetime,
"endDatetime": datetime,
"status": "SCHEDULED",
"instructions": "xyz789",
"type": "SCHEDULED",
"doneAt": datetime,
"doneBy": 4
}
SearchKwargsInput
Fields
| Input Field | Description |
|---|---|
preFilter - PreFilterInput
|
|
k - Int
|
|
fetchK - Int
|
Example
{"preFilter": PreFilterInput, "k": 123, "fetchK": 123}
SendCustomWrittenEmailSchema
SettingsSchema
Fields
| Field Name | Description |
|---|---|
practiceId - ID
|
|
featureFlags - [FeatureFlagSchema!]!
|
|
appointmentTypes - [AppointmentTypeSchema!]!
|
|
settingsId - String!
|
|
clinicLogo - MediaSchema
|
|
street - String
|
Street address of the clinic location. Used for client communications and service area determination |
city - String
|
City where the clinic is located. Used for geographic services and client communications |
state - String
|
State or province where the clinic is located. Used for tax calculations and regulatory compliance |
country - String
|
Country where the clinic is located. Affects tax calculations, regulations, and feature availability |
zipCode - String
|
Postal or ZIP code for the clinic location. Used for geographic services and delivery logistics |
name - String!
|
The display name of the veterinary clinic - required for clinic identification. Used throughout the application for branding and display purposes |
status - ClinicStatus
|
Current operational status of the clinic - affects appointment scheduling and client portal access. OPEN allows normal operations, CLOSED restricts scheduling and may hide certain features |
email - String!
|
Primary contact email for the clinic - required and must be unique across all clinics. Used for system notifications, client communications, and authentication. Enforced as unique in database indexes |
phone - String!
|
Primary clinic phone number - required, must be 10-15 digits. Used for client communications and appointment confirmations. Enforced as unique in database indexes |
twilioPhone - String
|
Twilio-registered phone number for SMS/voice communications. Must be 10-15 digits, used by Twilio services for outbound communications |
timezone - String!
|
Timezone for the clinic location - affects all datetime displays and scheduling logic. Must be a valid pytz timezone string, used by SettingsService.tz() for timezone conversion |
clinicLogoMediaId - ID
|
Reference to uploaded clinic logo media file (Media model). Used for invoice headers, client portal branding, and document generation |
vetcoveConnected - Boolean
|
Indicates if clinic has completed Vetcove integration setup. Used with vetcove_access_token to determine if Vetcove features are available |
tilledAccountId - String
|
Tilled payment processing account identifier. Required for payment processing functionality |
officeHours - OfficeHoursSchema
|
Weekly schedule configuration for the clinic. Used for appointment scheduling validation and client portal display. Validated in SettingsService._validate_settings() to ensure end times are after start times |
calendarOptions - CalendarOptionsSchema
|
Calendar display and behavior configuration. Controls appointment drag/drop, scheduling conflicts, and experimental features |
soapAutolockHours - Int
|
Number of hours after which SOAP notes become read-only. Prevents modification of medical records after specified time for compliance |
surgeryAutolockHours - Int
|
Number of hours after which surgery notes become read-only. Prevents modification of surgical records after specified time for compliance |
visitNoteAutolockHours - Int
|
Number of hours after which visit notes become read-only. Prevents modification of visit records after specified time for compliance |
appAutolockMinutes - Int
|
Minutes of inactivity before automatic application logout. Security feature to prevent unauthorized access to logged-in sessions |
vitalsAutolockHours - Int
|
Number of hours after which vital signs become read-only. Prevents modification of vital sign records after specified time for compliance |
taxRate - Float
|
Primary tax rate as decimal (0.000-100.000). For US: general tax rate, For Canada: GST/HST rate. Used in invoice calculations and pricing |
pstTaxRate - Float
|
Secondary tax rate as decimal (0.000-100.000). Used for additional tax calculations in regions with multiple tax types. For Canada: PST rate, for other countries: additional regional tax rate. |
taxRateSource - TaxRateSourceEnum
|
Source of tax rate for invoices. CLINIC uses clinic-wide settings, CLIENT_LOCATION uses client address-based rates |
prompts - [PromptSchema!]
|
AI prompts for different use cases (transcript processing, visit summaries). Used by AI services for generating SOAP notes and visit summaries |
emailEnabled - Boolean
|
Controls whether email functionality is enabled for the clinic. When false, email services and notifications are disabled |
replyToEmail - String
|
Reply-to address for outbound emails sent by the system. If not set, clinic email is used as reply-to address |
inventoryOptions - InventoryOptionsSchema
|
Inventory management configuration including usage priority (FIFO/LIFO). Controls how inventory items are consumed when multiple lots exist |
labIntegrationOptions - LabIntegrationOptionsSchema
|
Laboratory integration settings for multiple lab vendors. Contains credentials and API endpoints for IDEXX, Zoetis, Antech, etc. Used by lab workers to fetch results and submit orders |
idexxWebpacsOptions - IdexxWebpacsOptionsSchema
|
IDEXX WEBPACS imaging integration configuration. Contains credentials and settings for X-ray image retrieval |
soundvetOptions - SoundVetOptionsSchema
|
SoundVet imaging integration configuration. Contains API credentials and settings for X-ray workflows |
mangoAuthKey - String
|
Authentication key for Mango email service integration. Used for transactional email delivery |
clientPortalOptions - ClientPortalOptions
|
Client portal configuration including medical record visibility and prescription refill workflows. Controls which medical records are visible to clients and automatic task creation for refill requests. rx_refill_task_default_creator and rx_refill_task_default_assignee reference User model IDs |
directOnlineSchedulingOptions - DirectOnlineSchedulingOptionsSchema
|
Online appointment scheduling configuration for client self-service. Controls availability windows, approval requirements, and species restrictions. species_allowed contains SpeciesEnum values that can book online |
prescriptionOptions - PrescriptionOptionsSchema
|
Prescription management feature toggles. Controls UI shortcuts and automatic signature generation for prescriptions |
smsAppointmentReminderOptions - SmsAppointmentReminderOptionsSchema
|
SMS appointment reminder automation settings. Controls timing and scheduling of automated appointment reminders |
isSmsTreatmentReminderEnabled - Boolean
|
Enables SMS reminders for treatment follow-ups. When true, triggers automated SMS reminders for treatment compliance |
voipOptions - VoipOptionsSchema
|
VOIP phone system configuration. Contains greeting messages and call forwarding settings |
chartOptions - ChartOptionsSchema
|
Business intelligence dashboard configuration. Contains Chart.io dashboard IDs for embedded analytics |
patientDeceasedOptions - PatientDeceasedOptionsSchema
|
Controls visibility of deceased patients in search and family lists. Affects patient search results and dropdown population |
isRxLabelFlipped - Boolean
|
Controls prescription label orientation during printing. When true, flips label layout for different printer configurations |
rxLabelDimensions - LabelDimensionsSchema
|
Physical dimensions for prescription label printing. Width and height in inches with 3 decimal precision for precise printing |
patientIdLabelDimensions - LabelDimensionsSchema
|
Physical dimensions for patient ID label printing. Width and height in inches with 3 decimal precision for precise printing |
labResultsCallbackTaskOptions - LabResultsCallbackTaskOptionsSchema
|
Automatic task creation settings for lab result callbacks. When enabled, creates tasks when lab results require veterinarian review |
treatmentsMustBeNewerThan - datetime
|
Migration cutoff date - treatments older than this date are filtered from certain operations. Used to exclude legacy data during clinic migrations and data cleanup |
createdAt - String
|
|
updatedAt - String
|
|
weightUnit - WeightUnit
|
Default weight unit for patient measurements throughout the application. Affects all weight displays and calculations (KG or LB) |
visitSummary - VisitSummarySchema
|
Configuration for visit summary generation including which sections to include. Controls AI-generated visit summaries for SOAP notes and surgery reports |
estimateExpirationDays - Int
|
Number of days before estimates expire and become invalid. Used in estimate validation and client communications |
typesAndCategories - [TreatmentTypeSchema!]
|
Custom treatment type and category hierarchy for the clinic. Used for treatment classification and billing code organization. Validated to ensure all codes are unique across types, categories, and subcategories |
interestOptions - InterestOptionsSchema
|
Interest rate configuration for overdue account balances. Controls automatic interest calculation on aged receivables. min_overdue_balance stored as integer cents, not dollars |
pdfSettings - PdfSettingsSchema
|
PDF generation settings including text alignment. Controls layout and formatting of generated documents |
sisterClinics - [String!]
|
List of related clinic names for multi-clinic organizations. Used for cross-clinic reporting and shared resources |
accountsReceivableLastSyncedAt - datetime
|
Timestamp of last accounts receivable synchronization. Used to track data freshness for financial reporting |
migrationDate - datetime
|
Date when clinic was migrated to the current system. Used for data filtering and migration-related logic |
apiIntegrations - [String!]
|
List of approved server-to-server API integrations. Contains application identifiers that can access the clinic's API. See docs.nectarvet.com for integration details |
maintenanceMode - Boolean
|
Enables maintenance mode which restricts normal clinic operations. When true, prevents most user interactions and displays maintenance message |
specialCareNotes - SpecialCareNotesSettingsSchema
|
|
invoiceSettings - InvoiceSettingsSchema
|
|
estimateSettings - EstimateSettingsSchema
|
|
enableSso - Boolean
|
Whether to enable SSO for the clinic |
ipRestrictionEnabled - Boolean
|
Whether IP restrictions are enabled for the entire clinic |
clinicIpAddress - String
|
IP address that is allowed to access the clinic |
Example
{
"practiceId": 4,
"featureFlags": [FeatureFlagSchema],
"appointmentTypes": [AppointmentTypeSchema],
"settingsId": "xyz789",
"clinicLogo": MediaSchema,
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"country": "xyz789",
"zipCode": "xyz789",
"name": "xyz789",
"status": "OPEN",
"email": "abc123",
"phone": "abc123",
"twilioPhone": "abc123",
"timezone": "abc123",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"officeHours": OfficeHoursSchema,
"calendarOptions": CalendarOptionsSchema,
"soapAutolockHours": 123,
"surgeryAutolockHours": 987,
"visitNoteAutolockHours": 987,
"appAutolockMinutes": 987,
"vitalsAutolockHours": 123,
"taxRate": 123.45,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"prompts": [PromptSchema],
"emailEnabled": false,
"replyToEmail": "xyz789",
"inventoryOptions": InventoryOptionsSchema,
"labIntegrationOptions": LabIntegrationOptionsSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsSchema,
"soundvetOptions": SoundVetOptionsSchema,
"mangoAuthKey": "xyz789",
"clientPortalOptions": ClientPortalOptions,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsSchema,
"prescriptionOptions": PrescriptionOptionsSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsSchema,
"isSmsTreatmentReminderEnabled": true,
"voipOptions": VoipOptionsSchema,
"chartOptions": ChartOptionsSchema,
"patientDeceasedOptions": PatientDeceasedOptionsSchema,
"isRxLabelFlipped": true,
"rxLabelDimensions": LabelDimensionsSchema,
"patientIdLabelDimensions": LabelDimensionsSchema,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsSchema,
"treatmentsMustBeNewerThan": datetime,
"createdAt": "xyz789",
"updatedAt": "abc123",
"weightUnit": "KG",
"visitSummary": VisitSummarySchema,
"estimateExpirationDays": 123,
"typesAndCategories": [TreatmentTypeSchema],
"interestOptions": InterestOptionsSchema,
"pdfSettings": PdfSettingsSchema,
"sisterClinics": ["abc123"],
"accountsReceivableLastSyncedAt": datetime,
"migrationDate": datetime,
"apiIntegrations": ["xyz789"],
"maintenanceMode": true,
"specialCareNotes": SpecialCareNotesSettingsSchema,
"invoiceSettings": InvoiceSettingsSchema,
"estimateSettings": EstimateSettingsSchema,
"enableSso": true,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
SettingsUpdateSchema
Fields
| Input Field | Description |
|---|---|
practiceId - ID
|
|
status - ClinicStatus
|
|
name - String
|
|
email - String
|
|
phone - String
|
|
street - String
|
|
city - String
|
|
state - String
|
|
country - String
|
|
zipCode - String
|
|
timezone - String
|
|
emailEnabled - Boolean
|
|
replyToEmail - String
|
|
clinicLogoMediaId - ID
|
|
vetcoveConnected - Boolean
|
|
tilledAccountId - String
|
|
vetcoveAccessToken - String
|
|
vetcoveRefreshToken - String
|
|
vetcovePatientsLastSyncedAt - datetime
|
|
vetcoveClientsLastSyncedAt - datetime
|
|
officeHours - OfficeHoursUpdateSchema
|
|
calendarOptions - CalendarOptionsUpdateSchema
|
|
soapAutolockHours - Int
|
|
surgeryAutolockHours - Int
|
|
visitNoteAutolockHours - Int
|
|
appAutolockMinutes - Int
|
|
vitalsAutolockHours - Int
|
|
taxRate - Float
|
|
pstTaxRate - Float
|
|
taxRateSource - TaxRateSourceEnum
|
|
updatedAt - datetime
|
|
featureFlags - [FeatureFlagUpdateSchema!]
|
|
prompts - [PromptUpdateSchema!]
|
|
inventoryOptions - InventoryOptionsUpdateSchema
|
|
idexxWebpacsOptions - IdexxWebpacsOptionsUpdateSchema
|
|
clientPortalOptions - ClientPortalOptionsUpdateSchema
|
|
directOnlineSchedulingOptions - DirectOnlineSchedulingOptionsUpdateSchema
|
|
prescriptionOptions - PrescriptionOptionsUpdateSchema
|
|
smsAppointmentReminderOptions - SmsAppointmentReminderOptionsUpdateSchema
|
|
isSmsTreatmentReminderEnabled - Boolean
|
|
labResultsCallbackTaskOptions - LabResultsCallbackTaskOptionsUpdateSchema
|
|
labIntegrationOptions - LabIntegrationOptionsUpdateSchema
|
|
voipOptions - VoipOptionsUpdateSchema
|
|
mangoAuthKey - String
|
|
chartOptions - ChartOptionsUpdateSchema
|
|
patientDeceasedOptions - PatientDeceasedOptionsUpdateSchema
|
|
isRxLabelFlipped - Boolean
|
|
rxLabelDimensions - LabelDimensionsUpdateSchema
|
|
patientIdLabelDimensions - LabelDimensionsUpdateSchema
|
|
weightUnit - WeightUnit
|
|
visitSummary - VisitSummaryUpdateSchema
|
|
estimateExpirationDays - Int
|
|
soundvetOptions - SoundVetOptionsUpdateSchema
|
|
typesAndCategories - [TreatmentTypeUpdateSchema!]
|
|
interestOptions - InterestOptionsUpdateSchema
|
|
apiIntegrations - [String!]
|
|
treatmentsMustBeNewerThan - datetime
|
|
pdfSettings - PdfSettingsUpdateSchema
|
|
accountsReceivableLastSyncedAt - datetime
|
|
invoiceSettings - InvoiceSettingsUpdateSchema
|
|
estimateSettings - EstimateSettingsUpdateSchema
|
|
specialCareNotes - SpecialCareNotesSettingsUpdateSchema
|
|
enableSso - Boolean
|
|
ipRestrictionEnabled - Boolean
|
|
clinicIpAddress - String
|
Example
{
"practiceId": 4,
"status": "OPEN",
"name": "abc123",
"email": "abc123",
"phone": "xyz789",
"street": "xyz789",
"city": "xyz789",
"state": "abc123",
"country": "abc123",
"zipCode": "xyz789",
"timezone": "abc123",
"emailEnabled": true,
"replyToEmail": "xyz789",
"clinicLogoMediaId": "4",
"vetcoveConnected": true,
"tilledAccountId": "xyz789",
"vetcoveAccessToken": "xyz789",
"vetcoveRefreshToken": "xyz789",
"vetcovePatientsLastSyncedAt": datetime,
"vetcoveClientsLastSyncedAt": datetime,
"officeHours": OfficeHoursUpdateSchema,
"calendarOptions": CalendarOptionsUpdateSchema,
"soapAutolockHours": 987,
"surgeryAutolockHours": 123,
"visitNoteAutolockHours": 123,
"appAutolockMinutes": 123,
"vitalsAutolockHours": 987,
"taxRate": 987.65,
"pstTaxRate": 987.65,
"taxRateSource": "CLINIC",
"updatedAt": datetime,
"featureFlags": [FeatureFlagUpdateSchema],
"prompts": [PromptUpdateSchema],
"inventoryOptions": InventoryOptionsUpdateSchema,
"idexxWebpacsOptions": IdexxWebpacsOptionsUpdateSchema,
"clientPortalOptions": ClientPortalOptionsUpdateSchema,
"directOnlineSchedulingOptions": DirectOnlineSchedulingOptionsUpdateSchema,
"prescriptionOptions": PrescriptionOptionsUpdateSchema,
"smsAppointmentReminderOptions": SmsAppointmentReminderOptionsUpdateSchema,
"isSmsTreatmentReminderEnabled": true,
"labResultsCallbackTaskOptions": LabResultsCallbackTaskOptionsUpdateSchema,
"labIntegrationOptions": LabIntegrationOptionsUpdateSchema,
"voipOptions": VoipOptionsUpdateSchema,
"mangoAuthKey": "abc123",
"chartOptions": ChartOptionsUpdateSchema,
"patientDeceasedOptions": PatientDeceasedOptionsUpdateSchema,
"isRxLabelFlipped": false,
"rxLabelDimensions": LabelDimensionsUpdateSchema,
"patientIdLabelDimensions": LabelDimensionsUpdateSchema,
"weightUnit": "KG",
"visitSummary": VisitSummaryUpdateSchema,
"estimateExpirationDays": 987,
"soundvetOptions": SoundVetOptionsUpdateSchema,
"typesAndCategories": [TreatmentTypeUpdateSchema],
"interestOptions": InterestOptionsUpdateSchema,
"apiIntegrations": ["xyz789"],
"treatmentsMustBeNewerThan": datetime,
"pdfSettings": PdfSettingsUpdateSchema,
"accountsReceivableLastSyncedAt": datetime,
"invoiceSettings": InvoiceSettingsUpdateSchema,
"estimateSettings": EstimateSettingsUpdateSchema,
"specialCareNotes": SpecialCareNotesSettingsUpdateSchema,
"enableSso": false,
"ipRestrictionEnabled": false,
"clinicIpAddress": "xyz789"
}
SmsAppointmentReminderOptionsSchema
SmsAppointmentReminderOptionsUpdateSchema
SmsConsent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPT_IN"
Soap
Fields
| Field Name | Description |
|---|---|
subjective - String!
|
|
objective - SoapObjective!
|
|
assessment - SoapAssessment!
|
|
plan - [String!]!
|
Example
{
"subjective": "abc123",
"objective": SoapObjective,
"assessment": SoapAssessment,
"plan": ["xyz789"]
}
SoapAddFormSchema
SoapAssessment
Fields
| Field Name | Description |
|---|---|
problems - [DiagnosisEntry!]!
|
|
diagnoses - [DiagnosisEntry!]!
|
|
ruleouts - [DiagnosisEntry!]!
|
|
notes - String!
|
Example
{
"problems": [DiagnosisEntry],
"diagnoses": [DiagnosisEntry],
"ruleouts": [DiagnosisEntry],
"notes": "abc123"
}
SoapAssessmentCreateSchema
Fields
| Input Field | Description |
|---|---|
problems - [SoapDiagnosisUpdateSchema!]
|
|
diagnoses - [SoapDiagnosisUpdateSchema!]
|
|
ruleouts - [SoapDiagnosisUpdateSchema!]
|
|
notes - String
|
Example
{
"problems": [SoapDiagnosisUpdateSchema],
"diagnoses": [SoapDiagnosisUpdateSchema],
"ruleouts": [SoapDiagnosisUpdateSchema],
"notes": "xyz789"
}
SoapAssessmentSchema
Fields
| Field Name | Description |
|---|---|
problems - [SoapDiagnosisSchema!]!
|
|
diagnoses - [SoapDiagnosisSchema!]!
|
|
ruleouts - [SoapDiagnosisSchema!]!
|
|
notes - String
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"problems": [SoapDiagnosisSchema],
"diagnoses": [SoapDiagnosisSchema],
"ruleouts": [SoapDiagnosisSchema],
"notes": "xyz789",
"createdAt": datetime,
"updatedAt": datetime
}
SoapAssessmentUpdateSchema
Fields
| Input Field | Description |
|---|---|
problems - [SoapDiagnosisUpdateSchema!]
|
|
diagnoses - [SoapDiagnosisUpdateSchema!]
|
|
ruleouts - [SoapDiagnosisUpdateSchema!]
|
|
notes - String
|
Example
{
"problems": [SoapDiagnosisUpdateSchema],
"diagnoses": [SoapDiagnosisUpdateSchema],
"ruleouts": [SoapDiagnosisUpdateSchema],
"notes": "abc123"
}
SoapCreateSchema
SoapDiagnosisSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
source - DiagnosisSourceEnum!
|
|
dischargeDocumentIds - [ID!]
|
Example
{
"id": "4",
"name": "abc123",
"source": "AAHA",
"dischargeDocumentIds": ["4"]
}
SoapDiagnosisUpdateSchema
SoapObjEntryEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NORMAL"
SoapObjective
Fields
| Field Name | Description |
|---|---|
skin - SoapObjectiveEntry!
|
|
eyes - SoapObjectiveEntry!
|
|
ears - SoapObjectiveEntry!
|
|
nose - SoapObjectiveEntry!
|
|
oral - SoapObjectiveEntry!
|
|
heart - SoapObjectiveEntry!
|
|
lungs - SoapObjectiveEntry!
|
|
ln - SoapObjectiveEntry!
|
|
abd - SoapObjectiveEntry!
|
|
urogenital - SoapObjectiveEntry!
|
|
ms - SoapObjectiveEntry!
|
|
neuro - SoapObjectiveEntry!
|
|
rectal - SoapObjectiveEntry!
|
|
notes - String!
|
Example
{
"skin": SoapObjectiveEntry,
"eyes": SoapObjectiveEntry,
"ears": SoapObjectiveEntry,
"nose": SoapObjectiveEntry,
"oral": SoapObjectiveEntry,
"heart": SoapObjectiveEntry,
"lungs": SoapObjectiveEntry,
"ln": SoapObjectiveEntry,
"abd": SoapObjectiveEntry,
"urogenital": SoapObjectiveEntry,
"ms": SoapObjectiveEntry,
"neuro": SoapObjectiveEntry,
"rectal": SoapObjectiveEntry,
"notes": "abc123"
}
SoapObjectiveCreateSchema
Fields
| Input Field | Description |
|---|---|
skin - SoapObjectiveEntryUpdateSchema
|
|
eyes - SoapObjectiveEntryUpdateSchema
|
|
ears - SoapObjectiveEntryUpdateSchema
|
|
nose - SoapObjectiveEntryUpdateSchema
|
|
oral - SoapObjectiveEntryUpdateSchema
|
|
heart - SoapObjectiveEntryUpdateSchema
|
|
lungs - SoapObjectiveEntryUpdateSchema
|
|
ln - SoapObjectiveEntryUpdateSchema
|
|
abd - SoapObjectiveEntryUpdateSchema
|
|
urogenital - SoapObjectiveEntryUpdateSchema
|
|
ms - SoapObjectiveEntryUpdateSchema
|
|
neuro - SoapObjectiveEntryUpdateSchema
|
|
rectal - SoapObjectiveEntryUpdateSchema
|
|
notes - String
|
Example
{
"skin": SoapObjectiveEntryUpdateSchema,
"eyes": SoapObjectiveEntryUpdateSchema,
"ears": SoapObjectiveEntryUpdateSchema,
"nose": SoapObjectiveEntryUpdateSchema,
"oral": SoapObjectiveEntryUpdateSchema,
"heart": SoapObjectiveEntryUpdateSchema,
"lungs": SoapObjectiveEntryUpdateSchema,
"ln": SoapObjectiveEntryUpdateSchema,
"abd": SoapObjectiveEntryUpdateSchema,
"urogenital": SoapObjectiveEntryUpdateSchema,
"ms": SoapObjectiveEntryUpdateSchema,
"neuro": SoapObjectiveEntryUpdateSchema,
"rectal": SoapObjectiveEntryUpdateSchema,
"notes": "xyz789"
}
SoapObjectiveEntry
Fields
| Field Name | Description |
|---|---|
status - SoapObjEntryEnum!
|
|
notes - String!
|
Example
{"status": "NORMAL", "notes": "abc123"}
SoapObjectiveEntrySchema
Fields
| Field Name | Description |
|---|---|
status - SoapObjEntryEnum!
|
|
notes - String
|
|
updatedAt - datetime!
|
Example
{
"status": "NORMAL",
"notes": "abc123",
"updatedAt": datetime
}
SoapObjectiveEntryUpdateSchema
Fields
| Input Field | Description |
|---|---|
status - SoapObjEntryEnum
|
|
notes - String
|
Example
{"status": "NORMAL", "notes": "abc123"}
SoapObjectiveSchema
Fields
| Field Name | Description |
|---|---|
skin - SoapObjectiveEntrySchema!
|
|
eyes - SoapObjectiveEntrySchema!
|
|
ears - SoapObjectiveEntrySchema!
|
|
nose - SoapObjectiveEntrySchema!
|
|
oral - SoapObjectiveEntrySchema!
|
|
heart - SoapObjectiveEntrySchema!
|
|
lungs - SoapObjectiveEntrySchema!
|
|
ln - SoapObjectiveEntrySchema!
|
|
abd - SoapObjectiveEntrySchema!
|
|
urogenital - SoapObjectiveEntrySchema!
|
|
ms - SoapObjectiveEntrySchema!
|
|
neuro - SoapObjectiveEntrySchema!
|
|
rectal - SoapObjectiveEntrySchema!
|
|
notes - String
|
|
createdAt - datetime!
|
Example
{
"skin": SoapObjectiveEntrySchema,
"eyes": SoapObjectiveEntrySchema,
"ears": SoapObjectiveEntrySchema,
"nose": SoapObjectiveEntrySchema,
"oral": SoapObjectiveEntrySchema,
"heart": SoapObjectiveEntrySchema,
"lungs": SoapObjectiveEntrySchema,
"ln": SoapObjectiveEntrySchema,
"abd": SoapObjectiveEntrySchema,
"urogenital": SoapObjectiveEntrySchema,
"ms": SoapObjectiveEntrySchema,
"neuro": SoapObjectiveEntrySchema,
"rectal": SoapObjectiveEntrySchema,
"notes": "abc123",
"createdAt": datetime
}
SoapObjectiveUpdateSchema
Fields
| Input Field | Description |
|---|---|
skin - SoapObjectiveEntryUpdateSchema
|
|
eyes - SoapObjectiveEntryUpdateSchema
|
|
ears - SoapObjectiveEntryUpdateSchema
|
|
nose - SoapObjectiveEntryUpdateSchema
|
|
oral - SoapObjectiveEntryUpdateSchema
|
|
heart - SoapObjectiveEntryUpdateSchema
|
|
lungs - SoapObjectiveEntryUpdateSchema
|
|
ln - SoapObjectiveEntryUpdateSchema
|
|
abd - SoapObjectiveEntryUpdateSchema
|
|
urogenital - SoapObjectiveEntryUpdateSchema
|
|
ms - SoapObjectiveEntryUpdateSchema
|
|
neuro - SoapObjectiveEntryUpdateSchema
|
|
rectal - SoapObjectiveEntryUpdateSchema
|
|
notes - String
|
Example
{
"skin": SoapObjectiveEntryUpdateSchema,
"eyes": SoapObjectiveEntryUpdateSchema,
"ears": SoapObjectiveEntryUpdateSchema,
"nose": SoapObjectiveEntryUpdateSchema,
"oral": SoapObjectiveEntryUpdateSchema,
"heart": SoapObjectiveEntryUpdateSchema,
"lungs": SoapObjectiveEntryUpdateSchema,
"ln": SoapObjectiveEntryUpdateSchema,
"abd": SoapObjectiveEntryUpdateSchema,
"urogenital": SoapObjectiveEntryUpdateSchema,
"ms": SoapObjectiveEntryUpdateSchema,
"neuro": SoapObjectiveEntryUpdateSchema,
"rectal": SoapObjectiveEntryUpdateSchema,
"notes": "abc123"
}
SoapResponse
Fields
| Field Name | Description |
|---|---|
convertedSoapNote - Soap
|
|
content - String
|
|
prescribedTreatments - [PrescribedTreatmentSchema!]
|
Example
{
"convertedSoapNote": Soap,
"content": "xyz789",
"prescribedTreatments": [PrescribedTreatmentSchema]
}
SoapSchema
Fields
| Field Name | Description |
|---|---|
patientVitals - PatientVitalSchema
|
|
estimates - [EstimateSchema!]
|
|
invoices - [InvoiceViewSchema!]
|
|
vitals - [PatientVitalSchema!]
|
|
addendums - [AddendumSchema!]
|
|
media - [MediaSchema!]
|
|
creator - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patient - PatientSchema!
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
noteType - NoteType
|
Determines the specific note type - affects display, validation, and auto-lock behavior. Each note type has different auto-lock timeouts and specific business logic |
patientId - ID!
|
Required reference to the patient this note belongs to (ClinicPatient model). Used for patient history tracking and medical record organization |
providerId - ID
|
The primary veterinary provider responsible for this note (ClinicUser model). Auto-populated from appointment assigned employee if they are a provider. Falls back to default vet assigned to patient for current day if no appointment |
creatorUid - ID
|
The user who originally created this note (ClinicUser model). Used for audit trails and permission checks |
techUid - ID
|
The veterinary technician associated with this note (ClinicUser model). Typically assigned during appointment scheduling or note creation |
appointmentId - ID
|
Reference to the appointment this note was created from (Appointment model). Used to inherit appointment details like assigned staff and appointment type |
appointmentTypeId - ID
|
Reference to the type of appointment this note relates to (AppointmentType model). Auto-populated from linked appointment for categorization and reporting |
treatments - [PrescribedTreatmentSchema!]
|
List of prescribed treatments, medications, and procedures for this note. Syncs to invoicing system when auto-charge capture is enabled. Each treatment includes quantity, instructions, pricing, and fulfillment details |
followUps - [FollowUpSchema!]
|
List of recommended follow-up appointments and care instructions. Each follow-up includes appointment type, reason, and recommended timing |
status - SoapStatusEnum
|
Current workflow status of the note - controls editability and triggers side effects. DRAFT: editable, auto-locks after clinic-configured hours. FINAL: locked, triggers patient history updates and patient annotation creation. VOIDED/DELETED: reverses patient annotations and marks as inactive |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
autolockCreatedAt - datetime
|
Optional reference datetime for auto-lock functionality. When set, this datetime is used instead of created_at for calculating auto-lock timing (autolock_created_at + autolock_hours). Allows for custom auto-lock reference timing per note |
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
List of patient body diagrams with annotations for visual medical documentation. When note is finalized, default body diagram annotations are copied to patient annotations. Supports multiple diagram types including body maps and custom medical illustrations |
vet - ClinicUserSchema
|
|
soapId - ID!
|
|
vetUid - ID
|
The provider ID - corresponds to provider_id in surgery notes |
voiceNoteId - ID
|
|
details - String
|
|
subjective - String
|
|
objective - SoapObjectiveSchema!
|
|
assessment - SoapAssessmentSchema!
|
|
recs - String
|
|
forms - [ID!]
|
|
voiceNoteApprovedSignature - String
|
Example
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": "4",
"noteType": "SOAP",
"patientId": 4,
"providerId": 4,
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [SoapSurgeryPatientDiagramSchema],
"vet": ClinicUserSchema,
"soapId": "4",
"vetUid": "4",
"voiceNoteId": 4,
"details": "xyz789",
"subjective": "abc123",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"recs": "xyz789",
"forms": ["4"],
"voiceNoteApprovedSignature": "xyz789"
}
SoapSchemaSurgerySchemaVisitNoteSchema
Types
| Union Types |
|---|
Example
SoapSchema
SoapStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
SoapSurgeryPatientDiagramAnnotationSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
description - String!
|
|
color - String!
|
|
status - PatientAnnotationStatusEnum!
|
|
previousId - ID
|
|
coordinates - JSON!
|
|
number - Int!
|
|
creatorId - ID
|
|
resolverId - ID
|
|
resolvedAt - datetime
|
|
resolveReason - String
|
|
createdAt - datetime!
|
Example
{
"id": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": 4,
"description": "abc123",
"color": "xyz789",
"status": "OPEN",
"previousId": "4",
"coordinates": {},
"number": 987,
"creatorId": "4",
"resolverId": "4",
"resolvedAt": datetime,
"resolveReason": "abc123",
"createdAt": datetime
}
SoapSurgeryPatientDiagramAnnotationUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
soapId - ID
|
Reference to the SOAP record this annotation belongs to (Soap model). Either soap_id, surgery_id, or visit_note_id must be provided depending on context. Default = null |
surgeryId - ID
|
Reference to the surgery record this annotation belongs to (Surgery model). Either soap_id, surgery_id, or visit_note_id must be provided depending on context. Default = null |
visitNoteId - ID
|
Reference to the visit note record this annotation belongs to (VisitNote model). Either soap_id, surgery_id, or visit_note_id must be provided depending on context. Default = null |
description - String!
|
Text description of the annotation explaining the medical finding or note. |
color - String!
|
Hex color code for visual representation of the annotation on the diagram. |
status - PatientAnnotationStatusEnum!
|
Current status of the annotation - OPEN or RESOLVED. Affects workflow and determines if resolver fields are required. |
previousId - ID
|
Reference to a previous version of this annotation for tracking changes. Used for annotation history and edit tracking. Default = null |
coordinates - JSON!
|
JSON data containing x,y coordinates and shape information for positioning the annotation on the diagram. Format depends on the frontend canvas implementation. |
number - Int!
|
Sequential number for ordering annotations within a diagram. Used for consistent display order and referencing. |
creatorId - ID
|
Reference to the clinic user who created this annotation (ClinicUser model). Optional for system-generated annotations. Default = null |
resolverId - ID
|
Reference to the clinic user who resolved this annotation (ClinicUser model). Required when status is RESOLVED. Default = null |
resolvedAt - datetime
|
Timestamp when the annotation was resolved. Automatically set when status changes to RESOLVED. Default = null |
resolveReason - String
|
Explanation for why the annotation was resolved. Required when status is RESOLVED. Default = null |
createdAt - datetime!
|
Example
{
"id": "4",
"soapId": "4",
"surgeryId": 4,
"visitNoteId": 4,
"description": "abc123",
"color": "xyz789",
"status": "OPEN",
"previousId": 4,
"coordinates": {},
"number": 987,
"creatorId": 4,
"resolverId": "4",
"resolvedAt": datetime,
"resolveReason": "xyz789",
"createdAt": datetime
}
SoapSurgeryPatientDiagramSchema
Fields
| Field Name | Description |
|---|---|
media - MediaSchema!
|
|
id - ID!
|
|
title - String!
|
Human-readable name for the diagram template (e.g., 'Canine Body Diagram'). Must be unique within species and type combination. |
species - String!
|
Animal species this diagram applies to (e.g., 'canine', 'feline'). Used for filtering diagrams by patient species. |
type - PatientDiagramTypeEnum!
|
Type of diagram - body_diagram, eye, or dental. Determines the medical context and available annotation tools. |
mediaId - ID!
|
Reference to the base image file for this diagram (Media model). Must be a valid image file that exists in the media system. |
nectarDefault - Boolean!
|
Whether this is a system-provided default diagram. Default diagrams cannot be deleted and are available to all clinics. |
canvasJson - JSON
|
JSON data containing canvas state and custom drawing elements. Stores user-added shapes, lines, and other graphic elements. |
creatorId - ID
|
Reference to the clinic user who created this diagram template (ClinicUser model). Optional for system-default diagrams. |
createdAt - datetime
|
|
annotations - [SoapSurgeryPatientDiagramAnnotationSchema!]
|
List of annotations placed on this diagram instance. Each annotation represents a medical finding or note. |
Example
{
"media": MediaSchema,
"id": 4,
"title": "abc123",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": 4,
"nectarDefault": false,
"canvasJson": {},
"creatorId": "4",
"createdAt": datetime,
"annotations": [
SoapSurgeryPatientDiagramAnnotationSchema
]
}
SoapSurgeryPatientDiagramUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
title - String!
|
Human-readable name for the diagram template (e.g., 'Canine Body Diagram'). Must be unique within species and type combination. |
species - String!
|
Animal species this diagram applies to (e.g., 'canine', 'feline'). Used for filtering diagrams by patient species. |
type - PatientDiagramTypeEnum!
|
Type of diagram - body_diagram, eye, or dental. Determines the medical context and available annotation tools. |
mediaId - ID!
|
Reference to the base image file for this diagram (Media model). Must be a valid image file that exists in the media system. |
nectarDefault - Boolean!
|
Whether this is a system-provided default diagram. Default diagrams cannot be deleted and are available to all clinics. Default = false |
canvasJson - JSON
|
JSON data containing canvas state and custom drawing elements. Stores user-added shapes, lines, and other graphic elements. Default = null |
creatorId - ID
|
Reference to the clinic user who created this diagram template (ClinicUser model). Optional for system-default diagrams. Default = null |
createdAt - datetime!
|
|
annotations - [SoapSurgeryPatientDiagramAnnotationUpdateSchema!]
|
List of annotations placed on this diagram instance. Each annotation represents a medical finding or note. Default = [] |
Example
{
"id": "4",
"title": "xyz789",
"species": "abc123",
"type": "BODY_DIAGRAM",
"mediaId": "4",
"nectarDefault": false,
"canvasJson": {},
"creatorId": 4,
"createdAt": datetime,
"annotations": [
SoapSurgeryPatientDiagramAnnotationUpdateSchema
]
}
SoapTemplateCreateSchema
Fields
| Input Field | Description |
|---|---|
creatorId - ID!
|
|
name - String!
|
|
species - String!
|
|
appointmentTypeId - ID
|
|
soapTemplateData - SoapTemplateDataCreateSchema
|
Example
{
"creatorId": 4,
"name": "abc123",
"species": "xyz789",
"appointmentTypeId": 4,
"soapTemplateData": SoapTemplateDataCreateSchema
}
SoapTemplateDataCreateSchema
Fields
| Input Field | Description |
|---|---|
details - String
|
|
subjective - String
|
|
objective - SoapObjectiveCreateSchema
|
|
assessment - SoapAssessmentCreateSchema
|
|
treatmentIds - [ID!]
|
|
recs - String
|
|
patientDiagrams - [SoapSurgeryPatientDiagramUpdateSchema!]
|
Example
{
"details": "abc123",
"subjective": "abc123",
"objective": SoapObjectiveCreateSchema,
"assessment": SoapAssessmentCreateSchema,
"treatmentIds": ["4"],
"recs": "abc123",
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
]
}
SoapTemplateDataSchema
Fields
| Field Name | Description |
|---|---|
treatments - [TreatmentSchema!]
|
|
details - String
|
|
subjective - String
|
|
objective - SoapObjectiveSchema
|
|
assessment - SoapAssessmentSchema
|
|
treatmentIds - [ID!]
|
|
recs - String
|
|
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
Example
{
"treatments": [TreatmentSchema],
"details": "abc123",
"subjective": "xyz789",
"objective": SoapObjectiveSchema,
"assessment": SoapAssessmentSchema,
"treatmentIds": [4],
"recs": "xyz789",
"patientDiagrams": [SoapSurgeryPatientDiagramSchema]
}
SoapTemplateDataUpdateSchema
Fields
| Input Field | Description |
|---|---|
details - String
|
|
subjective - String
|
|
objective - SoapObjectiveUpdateSchema
|
|
assessment - SoapAssessmentUpdateSchema
|
|
treatmentIds - [ID!]
|
|
recs - String
|
|
patientDiagrams - [SoapSurgeryPatientDiagramUpdateSchema!]
|
Example
{
"details": "xyz789",
"subjective": "abc123",
"objective": SoapObjectiveUpdateSchema,
"assessment": SoapAssessmentUpdateSchema,
"treatmentIds": [4],
"recs": "abc123",
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
]
}
SoapTemplateFilterSchema
Fields
| Input Field | Description |
|---|---|
deletedAt - StrFilter
|
|
creatorId - ObjectIdFilter
|
|
name - StrFilter
|
|
species - StrFilter
|
|
favoritedBy - ObjectIdFilter
|
|
appointmentTypeId - ObjectIdFilter
|
|
isDeleted - BoolFilter
|
|
createdAt - DateFilter
|
Example
{
"deletedAt": StrFilter,
"creatorId": ObjectIdFilter,
"name": StrFilter,
"species": StrFilter,
"favoritedBy": ObjectIdFilter,
"appointmentTypeId": ObjectIdFilter,
"isDeleted": BoolFilter,
"createdAt": DateFilter
}
SoapTemplateSchema
Example
{
"appointmentType": AppointmentTypeResolveSchema,
"id": "4",
"creatorId": "4",
"name": "xyz789",
"species": "abc123",
"appointmentTypeId": "4",
"isDeleted": false,
"favoritedBy": [4],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
SoapTemplateToggleFavoriteSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
action - ToggleActionEnum!
|
|
userId - ID
|
Example
{
"id": "4",
"action": "FAVORITE",
"userId": 4
}
SoapTemplateUpdateSchema
Example
{
"id": "4",
"name": "xyz789",
"species": "abc123",
"appointmentTypeId": 4,
"isDeleted": true,
"soapTemplateData": SoapTemplateDataUpdateSchema
}
SoapTemplateViewSchema
Fields
| Field Name | Description |
|---|---|
appointmentType - AppointmentTypeSchema
|
|
id - ID!
|
|
creatorId - ID
|
|
name - String!
|
|
species - String
|
|
appointmentTypeId - ID
|
|
isDeleted - Boolean
|
|
favoritedBy - [ID!]
|
|
soapTemplateData - SoapTemplateDataSchema
|
|
createdAt - datetime
|
|
updatedAt - datetime
|
|
creator - ClinicUserSchema
|
|
isFavorite - Boolean
|
Example
{
"appointmentType": AppointmentTypeSchema,
"id": 4,
"creatorId": 4,
"name": "xyz789",
"species": "xyz789",
"appointmentTypeId": 4,
"isDeleted": false,
"favoritedBy": ["4"],
"soapTemplateData": SoapTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime,
"creator": ClinicUserSchema,
"isFavorite": true
}
SoapTemplateViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SoapTemplateViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [SoapTemplateViewSchemaEdge]
}
SoapTemplateViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - SoapTemplateViewSchema!
|
|
cursor - String!
|
Example
{
"node": SoapTemplateViewSchema,
"cursor": "xyz789"
}
SoapUpdateMetaSchema
Fields
| Input Field | Description |
|---|---|
lastUpdatedAt - datetime
|
Example
{"lastUpdatedAt": datetime}
SoapUpdateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID
|
|
providerId - ID
|
|
techUid - ID
|
|
appointmentId - ID
|
|
appointmentTypeId - ID
|
|
treatments - [PrescribedTreatmentUpdateSchema!]
|
|
followUps - [FollowUpUpdateSchema!]
|
|
status - SoapStatusEnum
|
|
addendumIds - [ID!]
|
|
patientDiagrams - [SoapSurgeryPatientDiagramUpdateSchema!]
|
|
createdAt - datetime
|
|
autolockCreatedAt - datetime
|
|
voidReason - String
|
|
soapId - ID!
|
|
vetUid - ID
|
|
details - String
|
|
subjective - String
|
|
objective - SoapObjectiveUpdateSchema
|
|
assessment - SoapAssessmentUpdateSchema
|
|
voiceNoteApprovedSignature - String
|
|
recs - String
|
|
forms - [ID!]
|
Example
{
"patientId": 4,
"providerId": 4,
"techUid": 4,
"appointmentId": 4,
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentUpdateSchema],
"followUps": [FollowUpUpdateSchema],
"status": "DRAFT",
"addendumIds": [4],
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
],
"createdAt": datetime,
"autolockCreatedAt": datetime,
"voidReason": "abc123",
"soapId": 4,
"vetUid": "4",
"details": "abc123",
"subjective": "xyz789",
"objective": SoapObjectiveUpdateSchema,
"assessment": SoapAssessmentUpdateSchema,
"voiceNoteApprovedSignature": "abc123",
"recs": "abc123",
"forms": [4]
}
SoapViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
vetUid - ObjectIdFilter
|
|
patientDotSpecies - StrFilter
|
|
patientDotBreed - StrFilter
|
|
createdAt - DateFilter
|
|
status - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"vetUid": ObjectIdFilter,
"patientDotSpecies": StrFilter,
"patientDotBreed": StrFilter,
"createdAt": DateFilter,
"status": StrFilter
}
SoapViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vet - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patientId - ID
|
|
status - SoapStatusEnum!
|
|
patient - PatientSchema!
|
|
createdAt - datetime!
|
|
appointment - AppointmentSchema
|
|
appointmentType - AppointmentTypeResolveSchema
|
Example
{
"id": 4,
"vet": ClinicUserSchema,
"tech": ClinicUserSchema,
"patientId": 4,
"status": "DRAFT",
"patient": PatientSchema,
"createdAt": datetime,
"appointment": AppointmentSchema,
"appointmentType": AppointmentTypeResolveSchema
}
SoapViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SoapViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [SoapViewSchemaEdge]
}
SoapViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - SoapViewSchema!
|
|
cursor - String!
|
Example
{
"node": SoapViewSchema,
"cursor": "xyz789"
}
Sorter
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
order - QueryOrder!
|
Example
{"field": "abc123", "order": "ASCENDING"}
SoundVetOptionsSchema
SoundVetOptionsUpdateSchema
SpecialCareNoteCreateSchema
Fields
| Input Field | Description |
|---|---|
resourceId - ID!
|
|
resourceType - ResourceType!
|
|
note - String
|
|
noteType - String!
|
Example
{
"resourceId": "4",
"resourceType": "PATIENT",
"note": "xyz789",
"noteType": "xyz789"
}
SpecialCareNoteFilterSchema
Fields
| Input Field | Description |
|---|---|
resourceId - ID
|
|
resourceType - ResourceType
|
|
noteType - String
|
|
createdBy - ID
|
|
deletedAt - datetime
|
Example
{
"resourceId": 4,
"resourceType": "PATIENT",
"noteType": "xyz789",
"createdBy": "4",
"deletedAt": datetime
}
SpecialCareNoteSchema
Fields
| Field Name | Description |
|---|---|
createdByUser - ClinicUserSchema
|
|
updatedByUser - ClinicUserSchema
|
|
resource - PatientSchemaClinicUserSchema
|
|
id - ID!
|
MongoDB document ObjectID |
resourceId - ID!
|
|
resourceType - ResourceType!
|
|
createdBy - ID!
|
|
updatedBy - ID!
|
|
note - String
|
|
noteType - String
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"createdByUser": ClinicUserSchema,
"updatedByUser": ClinicUserSchema,
"resource": PatientSchema,
"id": "4",
"resourceId": 4,
"resourceType": "PATIENT",
"createdBy": "4",
"updatedBy": "4",
"note": "xyz789",
"noteType": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
SpecialCareNoteSettingsSchema
Example
{
"key": "xyz789",
"title": "xyz789",
"description": "abc123",
"color": "abc123",
"showOnProfile": true,
"showOnAppointment": true,
"showOnWhiteboard": true,
"showOnPatientLabel": false,
"showPopUp": false,
"enabled": true
}
SpecialCareNoteSettingsUpdateSchema
Example
{
"key": "xyz789",
"title": "abc123",
"description": "abc123",
"color": "xyz789",
"showOnProfile": false,
"showOnAppointment": false,
"showOnWhiteboard": false,
"showOnPatientLabel": false,
"showPopUp": true,
"enabled": true
}
SpecialCareNoteUpdateSchema
SpecialCareNotesSettingsSchema
Fields
| Field Name | Description |
|---|---|
patient - [SpecialCareNoteSettingsSchema!]
|
|
client - [SpecialCareNoteSettingsSchema!]
|
Example
{
"patient": [SpecialCareNoteSettingsSchema],
"client": [SpecialCareNoteSettingsSchema]
}
SpecialCareNotesSettingsUpdateSchema
Fields
| Input Field | Description |
|---|---|
patient - [SpecialCareNoteSettingsUpdateSchema!]
|
|
client - [SpecialCareNoteSettingsUpdateSchema!]
|
Example
{
"patient": [SpecialCareNoteSettingsUpdateSchema],
"client": [SpecialCareNoteSettingsUpdateSchema]
}
SpeciesCreateSchema
SpeciesSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
species - String!
|
Name of the animal species (e.g., 'Dog', 'Cat', 'Bird') |
imageData - String
|
Base64 encoded image data for species icon/illustration |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
custom - Boolean
|
Indicates if this is a custom species added by clinic (vs system default) |
Example
{
"id": 4,
"species": "abc123",
"imageData": "xyz789",
"createdAt": datetime,
"updatedAt": datetime,
"custom": false
}
SpeciesUpdateSchema
Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
StrFilter
Fields
| Input Field | Description |
|---|---|
value1 - String!
|
|
operator - ComparisonOperators!
|
|
value2 - String
|
Example
{
"value1": "xyz789",
"operator": "EQ",
"value2": "abc123"
}
StrListFilter
Fields
| Input Field | Description |
|---|---|
value1 - [String!]!
|
|
operator - ComparisonOperators!
|
|
value2 - String
|
Example
{
"value1": ["xyz789"],
"operator": "EQ",
"value2": "xyz789"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubscriptionSchema
Fields
| Field Name | Description |
|---|---|
client - ClinicUserSchema
|
|
family - FamilySchema
|
|
id - String!
|
|
accountId - String!
|
|
customerId - String!
|
|
status - SubscriptionStatus!
|
|
price - Int!
|
|
currency - Currency!
|
|
intervalUnit - String!
|
|
intervalCount - Int!
|
|
paymentMethodId - String
|
|
platformFeeAmount - Int
|
|
canceledAt - datetime
|
|
cancelAt - datetime
|
|
billingCycleAnchor - datetime
|
|
pausedAt - datetime
|
|
resumeAt - datetime
|
|
pauseAt - datetime
|
|
nextPaymentAt - datetime
|
|
metadata - JSON
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"client": ClinicUserSchema,
"family": FamilySchema,
"id": "abc123",
"accountId": "xyz789",
"customerId": "xyz789",
"status": "ACTIVE",
"price": 123,
"currency": "AUD",
"intervalUnit": "xyz789",
"intervalCount": 123,
"paymentMethodId": "xyz789",
"platformFeeAmount": 123,
"canceledAt": datetime,
"cancelAt": datetime,
"billingCycleAnchor": datetime,
"pausedAt": datetime,
"resumeAt": datetime,
"pauseAt": datetime,
"nextPaymentAt": datetime,
"metadata": {},
"createdAt": datetime,
"updatedAt": datetime
}
SubscriptionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
SubscriptionsListSchema
Fields
| Field Name | Description |
|---|---|
subscriptions - [SubscriptionSchema!]!
|
|
total - Int!
|
Example
{"subscriptions": [SubscriptionSchema], "total": 123}
SummaryReportSchema
Fields
| Field Name | Description |
|---|---|
categories - CategoryTotalsSchema!
|
|
totalsByTreatment - [TransactionsReportTreatmentsSchema!]!
|
|
totalsByEmployee - [TransactionsReportEmployeesSchema!]!
|
|
totalsByFamily - [TransactionsReportFamilySchema!]!
|
|
totalsByGroupDiscount - [TransactionsReportGroupDiscountSchema!]!
|
Example
{
"categories": CategoryTotalsSchema,
"totalsByTreatment": [
TransactionsReportTreatmentsSchema
],
"totalsByEmployee": [TransactionsReportEmployeesSchema],
"totalsByFamily": [TransactionsReportFamilySchema],
"totalsByGroupDiscount": [
TransactionsReportGroupDiscountSchema
]
}
SurgeryCreateSchema
SurgerySchema
Fields
| Field Name | Description |
|---|---|
patientVitals - PatientVitalSchema
|
|
estimates - [EstimateSchema!]
|
|
invoices - [InvoiceViewSchema!]
|
|
vitals - [PatientVitalSchema!]
|
|
addendums - [AddendumSchema!]
|
|
media - [MediaSchema!]
|
|
creator - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patient - PatientSchema!
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
noteType - NoteType
|
Determines the specific note type - affects display, validation, and auto-lock behavior. Each note type has different auto-lock timeouts and specific business logic |
patientId - ID!
|
Required reference to the patient this note belongs to (ClinicPatient model). Used for patient history tracking and medical record organization |
providerId - ID
|
The primary veterinary provider responsible for this note (ClinicUser model). Auto-populated from appointment assigned employee if they are a provider. Falls back to default vet assigned to patient for current day if no appointment |
creatorUid - ID
|
The user who originally created this note (ClinicUser model). Used for audit trails and permission checks |
techUid - ID
|
The veterinary technician associated with this note (ClinicUser model). Typically assigned during appointment scheduling or note creation |
appointmentId - ID
|
Reference to the appointment this note was created from (Appointment model). Used to inherit appointment details like assigned staff and appointment type |
appointmentTypeId - ID
|
Reference to the type of appointment this note relates to (AppointmentType model). Auto-populated from linked appointment for categorization and reporting |
treatments - [PrescribedTreatmentSchema!]
|
List of prescribed treatments, medications, and procedures for this note. Syncs to invoicing system when auto-charge capture is enabled. Each treatment includes quantity, instructions, pricing, and fulfillment details |
followUps - [FollowUpSchema!]
|
List of recommended follow-up appointments and care instructions. Each follow-up includes appointment type, reason, and recommended timing |
status - SoapStatusEnum
|
Current workflow status of the note - controls editability and triggers side effects. DRAFT: editable, auto-locks after clinic-configured hours. FINAL: locked, triggers patient history updates and patient annotation creation. VOIDED/DELETED: reverses patient annotations and marks as inactive |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
autolockCreatedAt - datetime
|
Optional reference datetime for auto-lock functionality. When set, this datetime is used instead of created_at for calculating auto-lock timing (autolock_created_at + autolock_hours). Allows for custom auto-lock reference timing per note |
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
List of patient body diagrams with annotations for visual medical documentation. When note is finalized, default body diagram annotations are copied to patient annotations. Supports multiple diagram types including body maps and custom medical illustrations |
vet - ClinicUserSchema
|
|
procedure - String
|
Free-text description of the medical procedure or examination performed. Used in note display strings and patient history summaries |
preop - PreopSchema!
|
Pre-operative assessment and preparation data |
intraop - IntraopSchema!
|
Intra-operative procedure and anesthesia data |
postop - PostopSchema!
|
Post-operative recovery data |
recordedSurgeryVitals - [RecordedSurgeryVitalSchema!]
|
Time-series vital sign recordings during surgery |
Example
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": "4",
"creatorUid": 4,
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [SoapSurgeryPatientDiagramSchema],
"vet": ClinicUserSchema,
"procedure": "xyz789",
"preop": PreopSchema,
"intraop": IntraopSchema,
"postop": PostopSchema,
"recordedSurgeryVitals": [RecordedSurgeryVitalSchema]
}
SurgeryTemplateCreateSchema
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
creatorId - ID!
|
|
species - String!
|
|
surgeryTemplateData - SurgeryTemplateDataCreateSchema
|
Example
{
"name": "xyz789",
"creatorId": 4,
"species": "xyz789",
"surgeryTemplateData": SurgeryTemplateDataCreateSchema
}
SurgeryTemplateDataCreateSchema
Example
{
"procedure": "abc123",
"preopNotes": "xyz789",
"intraopMedicationNotes": "xyz789",
"intraopProcedureNotes": "abc123",
"postopNotes": "abc123",
"treatmentIds": [4],
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
]
}
SurgeryTemplateDataSchema
Fields
| Field Name | Description |
|---|---|
treatments - [TreatmentSchema!]
|
|
procedure - String
|
|
preopNotes - String
|
|
intraopMedicationNotes - String
|
|
intraopProcedureNotes - String
|
|
postopNotes - String
|
|
treatmentIds - [ID!]
|
|
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
Example
{
"treatments": [TreatmentSchema],
"procedure": "abc123",
"preopNotes": "xyz789",
"intraopMedicationNotes": "xyz789",
"intraopProcedureNotes": "xyz789",
"postopNotes": "abc123",
"treatmentIds": [4],
"patientDiagrams": [SoapSurgeryPatientDiagramSchema]
}
SurgeryTemplateDataUpdateSchema
Example
{
"procedure": "abc123",
"preopNotes": "abc123",
"intraopMedicationNotes": "abc123",
"intraopProcedureNotes": "xyz789",
"postopNotes": "xyz789",
"treatmentIds": ["4"],
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
]
}
SurgeryTemplateFilterSchema
Fields
| Input Field | Description |
|---|---|
deletedAt - StrFilter
|
|
creatorId - ObjectIdFilter
|
|
name - StrFilter
|
|
species - StrFilter
|
|
favoritedBy - ObjectIdFilter
|
|
isDeleted - BoolFilter
|
|
createdAt - DateFilter
|
Example
{
"deletedAt": StrFilter,
"creatorId": ObjectIdFilter,
"name": StrFilter,
"species": StrFilter,
"favoritedBy": ObjectIdFilter,
"isDeleted": BoolFilter,
"createdAt": DateFilter
}
SurgeryTemplateSchema
Example
{
"id": 4,
"name": "abc123",
"creatorId": "4",
"species": "abc123",
"isDeleted": true,
"favoritedBy": [4],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
SurgeryTemplateToggleFavoriteSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
action - ToggleActionEnum!
|
|
userId - ID
|
Example
{
"id": "4",
"action": "FAVORITE",
"userId": 4
}
SurgeryTemplateUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
species - String
|
|
isDeleted - Boolean
|
|
surgeryTemplateData - SurgeryTemplateDataUpdateSchema
|
Example
{
"id": "4",
"name": "xyz789",
"species": "abc123",
"isDeleted": true,
"surgeryTemplateData": SurgeryTemplateDataUpdateSchema
}
SurgeryTemplateViewSchema
Example
{
"id": "4",
"name": "xyz789",
"creatorId": 4,
"species": "xyz789",
"isDeleted": false,
"favoritedBy": [4],
"surgeryTemplateData": SurgeryTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime,
"isFavorite": true,
"creator": ClinicUserSchema
}
SurgeryTemplateViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SurgeryTemplateViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [SurgeryTemplateViewSchemaEdge]
}
SurgeryTemplateViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - SurgeryTemplateViewSchema!
|
|
cursor - String!
|
Example
{
"node": SurgeryTemplateViewSchema,
"cursor": "abc123"
}
SurgeryUpdateMetaSchema
Fields
| Input Field | Description |
|---|---|
lastUpdatedAt - datetime
|
Example
{"lastUpdatedAt": datetime}
SurgeryUpdateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID
|
|
providerId - ID
|
|
techUid - ID
|
|
appointmentId - ID
|
|
appointmentTypeId - ID
|
|
treatments - [PrescribedTreatmentUpdateSchema!]
|
|
followUps - [FollowUpUpdateSchema!]
|
|
status - SoapStatusEnum
|
|
addendumIds - [ID!]
|
|
patientDiagrams - [SoapSurgeryPatientDiagramUpdateSchema!]
|
|
createdAt - datetime
|
|
autolockCreatedAt - datetime
|
|
voidReason - String
|
|
id - ID!
|
|
procedure - String
|
|
preop - PreopUpdateSchema
|
|
intraop - IntraopUpdateSchema
|
|
postop - PostopUpdateSchema
|
|
recordedSurgeryVitals - [RecordedSurgeryVitalUpdateSchema!]
|
Example
{
"patientId": 4,
"providerId": "4",
"techUid": 4,
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentUpdateSchema],
"followUps": [FollowUpUpdateSchema],
"status": "DRAFT",
"addendumIds": ["4"],
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
],
"createdAt": datetime,
"autolockCreatedAt": datetime,
"voidReason": "xyz789",
"id": "4",
"procedure": "abc123",
"preop": PreopUpdateSchema,
"intraop": IntraopUpdateSchema,
"postop": PostopUpdateSchema,
"recordedSurgeryVitals": [
RecordedSurgeryVitalUpdateSchema
]
}
SurgeryViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
providerId - ObjectIdFilter
|
|
patientDotSpecies - StrFilter
|
|
patientDotBreed - StrFilter
|
|
createdAt - DateFilter
|
|
status - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"providerId": ObjectIdFilter,
"patientDotSpecies": StrFilter,
"patientDotBreed": StrFilter,
"createdAt": DateFilter,
"status": StrFilter
}
SurgeryViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vet - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patientId - ID
|
|
status - SoapStatusEnum!
|
|
patient - PatientSchema!
|
|
createdAt - datetime!
|
|
appointment - AppointmentSchema
|
|
appointmentType - AppointmentTypeResolveSchema
|
Example
{
"id": "4",
"vet": ClinicUserSchema,
"tech": ClinicUserSchema,
"patientId": 4,
"status": "DRAFT",
"patient": PatientSchema,
"createdAt": datetime,
"appointment": AppointmentSchema,
"appointmentType": AppointmentTypeResolveSchema
}
SurgeryViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SurgeryViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [SurgeryViewSchemaEdge]
}
SurgeryViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - SurgeryViewSchema!
|
|
cursor - String!
|
Example
{
"node": SurgeryViewSchema,
"cursor": "xyz789"
}
SurgeryVitalCreateSchema
SurgeryVitalSchema
SurgeryVitalUpdateSchema
SurgeryVitalValueSchema
SurgeryVitalValueUpdateSchema
SurgeryVitalsReplaceSchema
Fields
| Input Field | Description |
|---|---|
surgeryVitals - [SurgeryVitalCreateSchema!]!
|
Example
{"surgeryVitals": [SurgeryVitalCreateSchema]}
TaskCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID
|
Reference to the patient this task is related to (ClinicPatient model). Default = null |
clientId - ID
|
Reference to the client/pet owner (ClinicUser model). Default = null |
creatorId - ID!
|
Reference to the user who created the task (ClinicUser model) |
assignedById - ID
|
Reference to the user who assigned the task (ClinicUser model). Default = null |
assigneeId - ID
|
Reference to the user assigned to complete the task (ClinicUser model). Default = null |
taskType - TaskType!
|
Category of task (callback, SMS, email, prescription refill, inventory, other) |
priority - Priority
|
Task urgency level - lower numbers indicate higher priority. Default = NONE |
status - Status
|
Current status of the task (open, done, canceled, deleted). Default = OPEN |
description - String
|
Detailed description of what needs to be done. Default = null |
dueAt - datetime
|
When the task should be completed by. Default = null |
refId - ID
|
Reference to related entity that triggered this task (e.g., reminder ID). Default = null |
Example
{
"patientId": 4,
"clientId": 4,
"creatorId": "4",
"assignedById": "4",
"assigneeId": 4,
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "abc123",
"dueAt": datetime,
"refId": 4
}
TaskDeleteSchema
TaskNoteCreateSchema
Example
{
"taskId": 4,
"taskType": "CALL_BACK",
"clientId": "4",
"patientId": "4",
"description": "abc123",
"doneAtDate": datetime,
"doneAtTime": datetime,
"employeeId": 4
}
TaskSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
patientId - ID
|
Reference to the patient this task is related to (ClinicPatient model) |
clientId - ID
|
Reference to the client/pet owner (ClinicUser model) |
creatorId - ID!
|
Reference to the user who created the task (ClinicUser model) |
assignedById - ID
|
Reference to the user who assigned the task (ClinicUser model) |
assigneeId - ID
|
Reference to the user assigned to complete the task (ClinicUser model) |
taskType - TaskType!
|
Category of task (callback, SMS, email, prescription refill, inventory, other) |
priority - Priority
|
Task urgency level - lower numbers indicate higher priority |
status - Status!
|
Current status of the task (open, done, canceled, deleted) |
description - String
|
Detailed description of what needs to be done |
dueAt - datetime
|
When the task should be completed by |
deletedAt - datetime
|
Soft deletion timestamp - when set, task is considered deleted |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"patientId": 4,
"clientId": "4",
"creatorId": 4,
"assignedById": 4,
"assigneeId": 4,
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "abc123",
"dueAt": datetime,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
TaskType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CALL_BACK"
TaskUpdateSchema
Example
{
"id": 4,
"patientId": "4",
"clientId": 4,
"assignedById": 4,
"assigneeId": "4",
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "xyz789",
"dueAt": datetime,
"deletedAt": null
}
TaskViewFilterSchema
Fields
| Input Field | Description |
|---|---|
clientId - ObjectIdFilter
|
|
patientId - ObjectIdFilter
|
|
assigneeId - ObjectIdFilter
|
|
assignedById - ObjectIdFilter
|
|
creatorId - ObjectIdFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
|
status - StrFilter
|
|
priority - StrFilter
|
|
taskType - StrFilter
|
|
dueAt - DateFilter
|
Example
{
"clientId": ObjectIdFilter,
"patientId": ObjectIdFilter,
"assigneeId": ObjectIdFilter,
"assignedById": ObjectIdFilter,
"creatorId": ObjectIdFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter,
"status": StrFilter,
"priority": StrFilter,
"taskType": StrFilter,
"dueAt": DateFilter
}
TaskViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
patient - PatientSchema
|
|
client - ClinicUserSchema
|
|
creator - ClinicUserSchema!
|
|
assignedBy - ClinicUserSchema
|
|
assignee - ClinicUserSchema
|
|
taskType - TaskType!
|
|
priority - Priority
|
|
status - Status!
|
|
description - String
|
|
dueAt - datetime
|
|
refId - ID
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "4",
"patient": PatientSchema,
"client": ClinicUserSchema,
"creator": ClinicUserSchema,
"assignedBy": ClinicUserSchema,
"assignee": ClinicUserSchema,
"taskType": "CALL_BACK",
"priority": "URGENT",
"status": "OPEN",
"description": "abc123",
"dueAt": datetime,
"refId": "4",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
TaskViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [TaskViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [TaskViewSchemaEdge]
}
TaskViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - TaskViewSchema!
|
|
cursor - String!
|
Example
{
"node": TaskViewSchema,
"cursor": "abc123"
}
TaxRateSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLINIC"
TerminalReaderSchema
Example
{
"id": "xyz789",
"accountId": "abc123",
"type": "abc123",
"serialNumber": "xyz789",
"description": "xyz789",
"createdAt": datetime,
"updatedAt": datetime
}
TerminalUpdateSchema
Text
TextSchema
TilledInfoSchema
Fields
| Field Name | Description |
|---|---|
bankAccounts - [BankAccountSchema!]!
|
|
type - String!
|
Example
{
"bankAccounts": [BankAccountSchema],
"type": "xyz789"
}
TilledPaymentMethodsSchema
Fields
| Field Name | Description |
|---|---|
paymentMethods - [PaymentMethodSchema!]!
|
|
total - Int!
|
Example
{"paymentMethods": [PaymentMethodSchema], "total": 123}
TilledTerminalsSchema
Fields
| Field Name | Description |
|---|---|
terminals - [TerminalReaderSchema!]!
|
Example
{"terminals": [TerminalReaderSchema]}
TimingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IMMEDIATE"
TodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
Example
{
"id": "4",
"completed": false,
"todoType": "VACCINE_CERTIFICATE"
}
TodoType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VACCINE_CERTIFICATE"
ToggleActionEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FAVORITE"
ToggleTodoSchema
TransactionBaseViewSchema
Fields
| Field Name | Description |
|---|---|
client - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
invoice - InvoiceSchema
|
|
patient - PatientSchema
|
|
family - FamilySchema
|
|
otherInvoices - [InvoiceSchema!]
|
|
paymentIntent - PaymentIntentSchema
|
|
id - ID!
|
MongoDB document ObjectID |
transactionId - ID!
|
Unique identifier for the transaction |
familyId - ID!
|
The family associated with this transaction (required). Connects to Family model. Used for calculating family account balances and store credit balances |
clientId - ID
|
The client associated with this transaction, if applicable. Connects to ClinicUser model. May be null for system-generated transactions or cash reconciliation |
creatorUid - ID
|
The user who created this transaction. Connects to ClinicUser model. Used for tracking who performed the transaction and for commission calculations |
transactionType - TransactionTypeEnum!
|
Type of transaction: CREDIT (money in) or DEBIT (money out). CREDIT transactions increase family balance_amount, DEBIT transactions decrease family balance_amount. For store credits, the behavior is more complex (see will_not_affect_outstanding_balance method) |
refType - TransactionRefTypeEnum!
|
Reference type: INVOICE or TRANSACTION. INVOICE: Transaction is linked to an invoice (payment or charge). TRANSACTION: Standalone transaction (e.g., deposit, refund, store credit) |
amount - Int
|
Amount in cents (integer). All monetary values are stored as integer cents to avoid floating-point precision issues. Example: $10.50 is stored as 1050 |
invoiceId - ID
|
The invoice this transaction is associated with, if any. Connects to Invoice model. When set, indicates this transaction is a payment for or charge of a specific invoice |
voidedTransactionId - ID
|
For void/refund transactions, references the original transaction being voided. When set, indicates this transaction is reversing another transaction. Used with transaction_type to determine if it's a void or refund |
otherInvoiceIds - [ID!]
|
For transactions that pay multiple invoices, lists all other invoices being paid. Only used when a single payment is split across multiple invoices. The system creates separate transactions for each invoice, with references to others |
otherTransactionIds - [ID!]
|
For transactions that are part of a group (split payments), lists related transactions. Contains IDs of other transactions created from the same original payment. Used to maintain relationships between split transactions |
partialVoid - Boolean
|
Indicates if this is a partial void/refund of the original transaction. When True, only a portion of the original transaction was voided/refunded. Affects validation logic for future voids/refunds of the same transaction |
method - MethodEnum
|
Payment method used (CASH, CHECK, CREDIT_CARD, etc.). Affects how the transaction impacts family balances. STORE_CREDIT and ACCOUNT_BALANCE have special handling for balance calculations. Note: DEBIT transactions may not have a payment method |
network - NetworkEnum
|
Payment network used (VISA, MASTERCARD, VENMO, etc.). Provides additional detail for certain payment methods. Used for reporting and reconciliation. Note: DEBIT transactions may not have a payment network |
notes - String
|
Optional notes about the transaction. Can contain reason for refund, void explanation, or other context |
paymentIntentId - String
|
NectarPay payment intent ID for credit card transactions. Links to the payment processor's transaction record. Used for refunds, disputes, and payment verification |
refundId - String
|
ID for refund transactions in the payment processor. Only set for refund transactions processed through NectarPay |
createdAt - datetime
|
When the transaction was created. Used for reporting, sorting, and calculating running balances |
balanceAmount - Int
|
Running balance of the family account at the time of this transaction. Used to display account balance history. May be null for transactions before this feature was implemented. Updated by recal_family_transaction_account_balances in FamilyService |
isManualPartialRefund - Boolean
|
Example
{
"client": ClinicUserSchema,
"provider": ClinicUserSchema,
"invoice": InvoiceSchema,
"patient": PatientSchema,
"family": FamilySchema,
"otherInvoices": [InvoiceSchema],
"paymentIntent": PaymentIntentSchema,
"id": "4",
"transactionId": "4",
"familyId": "4",
"clientId": 4,
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": 4,
"voidedTransactionId": 4,
"otherInvoiceIds": ["4"],
"otherTransactionIds": [4],
"partialVoid": true,
"method": "CASH",
"network": "PRO_BONO",
"notes": "xyz789",
"paymentIntentId": "xyz789",
"refundId": "xyz789",
"createdAt": datetime,
"balanceAmount": 987,
"isManualPartialRefund": false
}
TransactionByPaymentMethodSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
transactions - [TransactionViewSchema!]!
|
Example
{
"id": "xyz789",
"transactions": [TransactionViewSchema]
}
TransactionCreateSchema
Fields
| Input Field | Description |
|---|---|
familyId - ID!
|
|
clientId - ID
|
|
creatorUid - ID
|
|
transactionType - TransactionTypeEnum!
|
|
refType - TransactionRefTypeEnum
|
|
amount - Int!
|
|
method - MethodEnum
|
|
paymentMethodId - String
|
|
terminalId - String
|
|
network - NetworkEnum
|
|
invoiceId - ID
|
|
otherInvoiceIds - [ID!]
|
|
voidedTransactionId - ID
|
|
isManualPartialRefund - Boolean
|
|
partialVoid - Boolean
|
|
notes - String
|
|
attachCard - Boolean
|
|
createdAt - datetime!
|
Example
{
"familyId": 4,
"clientId": "4",
"creatorUid": "4",
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 987,
"method": "CASH",
"paymentMethodId": "abc123",
"terminalId": "abc123",
"network": "PRO_BONO",
"invoiceId": 4,
"otherInvoiceIds": ["4"],
"voidedTransactionId": 4,
"isManualPartialRefund": false,
"partialVoid": true,
"notes": "abc123",
"attachCard": false,
"createdAt": datetime
}
TransactionFilterSchema
Fields
| Input Field | Description |
|---|---|
transactionId - ListObjectIdFilter
|
|
familyId - ObjectIdFilter
|
|
clientId - ObjectIdFilter
|
|
creatorUid - ObjectIdFilter
|
|
transactionType - StrFilter
|
|
method - StrFilter
|
|
network - StrFilter
|
|
createdAt - DateFilter
|
|
voidedTransactionId - ObjectIdFilter
|
|
invoiceId - ObjectIdFilter
|
Example
{
"transactionId": ListObjectIdFilter,
"familyId": ObjectIdFilter,
"clientId": ObjectIdFilter,
"creatorUid": ObjectIdFilter,
"transactionType": StrFilter,
"method": StrFilter,
"network": StrFilter,
"createdAt": DateFilter,
"voidedTransactionId": ObjectIdFilter,
"invoiceId": ObjectIdFilter
}
TransactionInvoiceLinkSchema
TransactionQueryFilter
Fields
| Input Field | Description |
|---|---|
familyId - ID
|
|
clientId - ID
|
|
creatorUid - ID
|
|
transactionType - TransactionTypeEnum
|
|
refType - TransactionRefTypeEnum
|
|
method - MethodEnum
|
|
network - NetworkEnum
|
|
invoiceId - ID
|
|
voidedTransactionId - ID
|
|
startDatetime - datetime
|
|
endDatetime - datetime
|
Example
{
"familyId": "4",
"clientId": 4,
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"method": "CASH",
"network": "PRO_BONO",
"invoiceId": 4,
"voidedTransactionId": "4",
"startDatetime": datetime,
"endDatetime": datetime
}
TransactionRefTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INVOICE"
TransactionRefundSchema
Fields
| Input Field | Description |
|---|---|
transactionId - ID!
|
|
creatorUid - ID!
|
|
amount - Int
|
|
method - MethodEnum
|
|
network - NetworkEnum
|
|
reason - String
|
|
partialRefund - Boolean
|
Example
{
"transactionId": "4",
"creatorUid": "4",
"amount": 123,
"method": "CASH",
"network": "PRO_BONO",
"reason": "xyz789",
"partialRefund": false
}
TransactionSchema
Fields
| Field Name | Description |
|---|---|
family - FamilyViewSchema
|
|
client - ClinicUserSchema
|
|
employee - ClinicUserSchema
|
|
invoice - InvoiceViewSchema
|
|
isInterestCharge - Boolean!
|
|
transactionId - ID!
|
Unique identifier for the transaction |
familyId - ID!
|
The family associated with this transaction (required). Connects to Family model. Used for calculating family account balances and store credit balances |
clientId - ID
|
The client associated with this transaction, if applicable. Connects to ClinicUser model. May be null for system-generated transactions or cash reconciliation |
creatorUid - ID
|
The user who created this transaction. Connects to ClinicUser model. Used for tracking who performed the transaction and for commission calculations |
transactionType - TransactionTypeEnum!
|
Type of transaction: CREDIT (money in) or DEBIT (money out). CREDIT transactions increase family balance_amount, DEBIT transactions decrease family balance_amount. For store credits, the behavior is more complex (see will_not_affect_outstanding_balance method) |
refType - TransactionRefTypeEnum!
|
Reference type: INVOICE or TRANSACTION. INVOICE: Transaction is linked to an invoice (payment or charge). TRANSACTION: Standalone transaction (e.g., deposit, refund, store credit) |
amount - Int
|
Amount in cents (integer). All monetary values are stored as integer cents to avoid floating-point precision issues. Example: $10.50 is stored as 1050 |
invoiceId - ID
|
The invoice this transaction is associated with, if any. Connects to Invoice model. When set, indicates this transaction is a payment for or charge of a specific invoice |
voidedTransactionId - ID
|
For void/refund transactions, references the original transaction being voided. When set, indicates this transaction is reversing another transaction. Used with transaction_type to determine if it's a void or refund |
otherInvoiceIds - [ID!]
|
For transactions that pay multiple invoices, lists all other invoices being paid. Only used when a single payment is split across multiple invoices. The system creates separate transactions for each invoice, with references to others |
otherTransactionIds - [ID!]
|
For transactions that are part of a group (split payments), lists related transactions. Contains IDs of other transactions created from the same original payment. Used to maintain relationships between split transactions |
partialVoid - Boolean
|
Indicates if this is a partial void/refund of the original transaction. When True, only a portion of the original transaction was voided/refunded. Affects validation logic for future voids/refunds of the same transaction |
method - MethodEnum
|
Payment method used (CASH, CHECK, CREDIT_CARD, etc.). Affects how the transaction impacts family balances. STORE_CREDIT and ACCOUNT_BALANCE have special handling for balance calculations. Note: DEBIT transactions may not have a payment method |
network - NetworkEnum
|
Payment network used (VISA, MASTERCARD, VENMO, etc.). Provides additional detail for certain payment methods. Used for reporting and reconciliation. Note: DEBIT transactions may not have a payment network |
notes - String
|
Optional notes about the transaction. Can contain reason for refund, void explanation, or other context |
paymentIntentId - String
|
NectarPay payment intent ID for credit card transactions. Links to the payment processor's transaction record. Used for refunds, disputes, and payment verification |
refundId - String
|
ID for refund transactions in the payment processor. Only set for refund transactions processed through NectarPay |
createdAt - datetime
|
When the transaction was created. Used for reporting, sorting, and calculating running balances |
balanceAmount - Int
|
Running balance of the family account at the time of this transaction. Used to display account balance history. May be null for transactions before this feature was implemented. Updated by recal_family_transaction_account_balances in FamilyService |
isManualPartialRefund - Boolean
|
Example
{
"family": FamilyViewSchema,
"client": ClinicUserSchema,
"employee": ClinicUserSchema,
"invoice": InvoiceViewSchema,
"isInterestCharge": false,
"transactionId": 4,
"familyId": 4,
"clientId": 4,
"creatorUid": 4,
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 987,
"invoiceId": "4",
"voidedTransactionId": 4,
"otherInvoiceIds": ["4"],
"otherTransactionIds": [4],
"partialVoid": false,
"method": "CASH",
"network": "PRO_BONO",
"notes": "abc123",
"paymentIntentId": "xyz789",
"refundId": "abc123",
"createdAt": datetime,
"balanceAmount": 123,
"isManualPartialRefund": false
}
TransactionSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [TransactionSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [TransactionSchemaEdge]
}
TransactionSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - TransactionSchema!
|
|
cursor - String!
|
Example
{
"node": TransactionSchema,
"cursor": "xyz789"
}
TransactionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREDIT"
TransactionUpdateSchema
TransactionViewSchema
Fields
| Field Name | Description |
|---|---|
client - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
invoice - InvoiceSchema
|
|
patient - PatientSchema
|
|
family - FamilySchema
|
|
otherInvoices - [InvoiceSchema!]
|
|
paymentIntent - PaymentIntentSchema
|
|
id - ID!
|
|
transactionId - ID!
|
Unique identifier for the transaction |
familyId - ID!
|
The family associated with this transaction (required). Connects to Family model. Used for calculating family account balances and store credit balances |
clientId - ID
|
The client associated with this transaction, if applicable. Connects to ClinicUser model. May be null for system-generated transactions or cash reconciliation |
creatorUid - ID
|
The user who created this transaction. Connects to ClinicUser model. Used for tracking who performed the transaction and for commission calculations |
transactionType - TransactionTypeEnum!
|
Type of transaction: CREDIT (money in) or DEBIT (money out). CREDIT transactions increase family balance_amount, DEBIT transactions decrease family balance_amount. For store credits, the behavior is more complex (see will_not_affect_outstanding_balance method) |
refType - TransactionRefTypeEnum!
|
Reference type: INVOICE or TRANSACTION. INVOICE: Transaction is linked to an invoice (payment or charge). TRANSACTION: Standalone transaction (e.g., deposit, refund, store credit) |
amount - Int
|
Amount in cents (integer). All monetary values are stored as integer cents to avoid floating-point precision issues. Example: $10.50 is stored as 1050 |
invoiceId - ID
|
The invoice this transaction is associated with, if any. Connects to Invoice model. When set, indicates this transaction is a payment for or charge of a specific invoice |
voidedTransactionId - ID
|
For void/refund transactions, references the original transaction being voided. When set, indicates this transaction is reversing another transaction. Used with transaction_type to determine if it's a void or refund |
otherInvoiceIds - [ID!]
|
For transactions that pay multiple invoices, lists all other invoices being paid. Only used when a single payment is split across multiple invoices. The system creates separate transactions for each invoice, with references to others |
otherTransactionIds - [ID!]
|
For transactions that are part of a group (split payments), lists related transactions. Contains IDs of other transactions created from the same original payment. Used to maintain relationships between split transactions |
partialVoid - Boolean
|
Indicates if this is a partial void/refund of the original transaction. When True, only a portion of the original transaction was voided/refunded. Affects validation logic for future voids/refunds of the same transaction |
method - MethodEnum
|
Payment method used (CASH, CHECK, CREDIT_CARD, etc.). Affects how the transaction impacts family balances. STORE_CREDIT and ACCOUNT_BALANCE have special handling for balance calculations. Note: DEBIT transactions may not have a payment method |
network - NetworkEnum
|
Payment network used (VISA, MASTERCARD, VENMO, etc.). Provides additional detail for certain payment methods. Used for reporting and reconciliation. Note: DEBIT transactions may not have a payment network |
notes - String
|
Optional notes about the transaction. Can contain reason for refund, void explanation, or other context |
paymentIntentId - String
|
NectarPay payment intent ID for credit card transactions. Links to the payment processor's transaction record. Used for refunds, disputes, and payment verification |
refundId - String
|
ID for refund transactions in the payment processor. Only set for refund transactions processed through NectarPay |
createdAt - datetime
|
When the transaction was created. Used for reporting, sorting, and calculating running balances |
balanceAmount - Int
|
Running balance of the family account at the time of this transaction. Used to display account balance history. May be null for transactions before this feature was implemented. Updated by recal_family_transaction_account_balances in FamilyService |
isManualPartialRefund - Boolean
|
|
isInvoice - Boolean!
|
|
isPayment - Boolean!
|
|
isNectarPay - Boolean!
|
|
isVoidCharge - Boolean!
|
|
isVoidInvoice - Boolean!
|
|
isInterestCharge - Boolean!
|
|
otherTransactions - [TransactionBaseViewSchema!]
|
Example
{
"client": ClinicUserSchema,
"provider": ClinicUserSchema,
"invoice": InvoiceSchema,
"patient": PatientSchema,
"family": FamilySchema,
"otherInvoices": [InvoiceSchema],
"paymentIntent": PaymentIntentSchema,
"id": "4",
"transactionId": "4",
"familyId": "4",
"clientId": 4,
"creatorUid": "4",
"transactionType": "CREDIT",
"refType": "INVOICE",
"amount": 123,
"invoiceId": "4",
"voidedTransactionId": 4,
"otherInvoiceIds": [4],
"otherTransactionIds": [4],
"partialVoid": false,
"method": "CASH",
"network": "PRO_BONO",
"notes": "abc123",
"paymentIntentId": "xyz789",
"refundId": "abc123",
"createdAt": datetime,
"balanceAmount": 123,
"isManualPartialRefund": true,
"isInvoice": true,
"isPayment": false,
"isNectarPay": true,
"isVoidCharge": false,
"isVoidInvoice": true,
"isInterestCharge": true,
"otherTransactions": [TransactionBaseViewSchema]
}
TransactionViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [TransactionViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [TransactionViewSchemaEdge]
}
TransactionViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - TransactionViewSchema!
|
|
cursor - String!
|
Example
{
"node": TransactionViewSchema,
"cursor": "abc123"
}
TransactionVoidSchema
TransactionsReportAAHACategories
Example
{
"total": 987,
"type": "abc123",
"typeCode": "xyz789",
"category": "abc123",
"categoryCode": "xyz789",
"subCategory": "abc123",
"subCategoryCode": "abc123",
"totalInvoiced": 123
}
TransactionsReportEmployeesSchema
Fields
| Field Name | Description |
|---|---|
employee - ClinicUserSchema
|
|
chargedTotal - Int!
|
|
chargesVoidedTotal - Int!
|
|
treatments - [TransactionsReportTreatmentsSchema!]!
|
Example
{
"employee": ClinicUserSchema,
"chargedTotal": 987,
"chargesVoidedTotal": 123,
"treatments": [TransactionsReportTreatmentsSchema]
}
TransactionsReportFamilySchema
Fields
| Field Name | Description |
|---|---|
family - FamilySchema
|
|
chargedTotal - Int!
|
|
paidTotal - Int!
|
|
chargesVoidedTotal - Int!
|
|
paymentsVoidedTotal - Int!
|
Example
{
"family": FamilySchema,
"chargedTotal": 123,
"paidTotal": 987,
"chargesVoidedTotal": 987,
"paymentsVoidedTotal": 987
}
TransactionsReportGroupDiscountSchema
Fields
| Field Name | Description |
|---|---|
groupDiscount - GroupDiscountSchema
|
|
total - Int!
|
Example
{"groupDiscount": GroupDiscountSchema, "total": 987}
TransactionsReportInvoicesSchema
Example
{
"chargedSubtotal": 123,
"chargedFees": 987,
"chargedDiscounts": 987,
"chargedTaxes": 987,
"chargedPstTaxes": 987,
"chargedTotal": 987,
"voidedTotal": 987,
"netTotal": 987,
"netInterestCharged": 123
}
TransactionsReportPaymentMethodsSchema
TransactionsReportPaymentsSchema
Fields
| Field Name | Description |
|---|---|
paidTotal - Int!
|
|
paymentVoidedTotal - Int!
|
|
cashReconciliationTotal - Int!
|
|
netTotal - Int!
|
|
totalsByPaymentMethod - [TransactionsReportPaymentMethodsSchema!]!
|
|
totalsByCreditCardNetwork - [TransactionsReportPaymentMethodsSchema!]!
|
|
totalsByNectarpay - [TransactionsReportPaymentMethodsSchema!]!
|
|
totalsByAahaCategories - [TransactionsReportAAHACategories!]!
|
|
transactionsByPaymentMethods - [TransactionByPaymentMethodSchema!]!
|
Example
{
"paidTotal": 987,
"paymentVoidedTotal": 123,
"cashReconciliationTotal": 123,
"netTotal": 987,
"totalsByPaymentMethod": [
TransactionsReportPaymentMethodsSchema
],
"totalsByCreditCardNetwork": [
TransactionsReportPaymentMethodsSchema
],
"totalsByNectarpay": [
TransactionsReportPaymentMethodsSchema
],
"totalsByAahaCategories": [
TransactionsReportAAHACategories
],
"transactionsByPaymentMethods": [
TransactionByPaymentMethodSchema
]
}
TransactionsReportSchema
Fields
| Field Name | Description |
|---|---|
invoices - TransactionsReportInvoicesSchema!
|
|
payments - TransactionsReportPaymentsSchema!
|
|
accountsReceivable - TransactionsReportTotalSchema!
|
Example
{
"invoices": TransactionsReportInvoicesSchema,
"payments": TransactionsReportPaymentsSchema,
"accountsReceivable": TransactionsReportTotalSchema
}
TransactionsReportTotalSchema
Fields
| Field Name | Description |
|---|---|
invoiced - Int!
|
|
payments - Int!
|
|
netReceivable - Int!
|
|
storeCreditsIssued - Int!
|
|
receivablesTransactions - [TransactionViewSchema!]!
|
Example
{
"invoiced": 123,
"payments": 987,
"netReceivable": 123,
"storeCreditsIssued": 123,
"receivablesTransactions": [TransactionViewSchema]
}
TransactionsReportTreatmentsSchema
Example
{
"treatment": InvoiceItemSchema,
"chargedCount": 123,
"voidedCount": 987,
"chargedSubtotal": 123,
"voidedSubtotal": 123,
"chargedQuantity": 987,
"voidedQuantity": 123
}
TreatmentBasicSchema
TreatmentCategorySchema
Fields
| Field Name | Description |
|---|---|
category - String!
|
|
categoryCode - String!
|
|
locked - Boolean!
|
|
subCategories - [TreatmentSubCategorySchema!]
|
Example
{
"category": "xyz789",
"categoryCode": "xyz789",
"locked": true,
"subCategories": [TreatmentSubCategorySchema]
}
TreatmentCategoryUpdateSchema
Fields
| Input Field | Description |
|---|---|
category - String
|
|
categoryCode - String
|
|
locked - Boolean
|
|
subCategories - [TreatmentSubCategoryUpdateSchema!]
|
Example
{
"category": "xyz789",
"categoryCode": "abc123",
"locked": true,
"subCategories": [TreatmentSubCategoryUpdateSchema]
}
TreatmentCreateSchema
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
type - String!
|
|
typeCode - String!
|
|
category - String
|
|
categoryCode - String
|
|
subCategory - String
|
|
subCategoryCode - String
|
|
unit - UnitEnum
|
|
pricePerUnit - Int
|
|
minimumCharge - Int
|
|
adminFee - Int
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
isDiscountable - Boolean
|
|
isControlledSubstance - Boolean
|
|
instructions - String
|
|
inventoryHistoricalHighCostPerUnit - Int!
|
|
inventoryLatestCostPerUnit - Int!
|
|
species - String
|
|
manufacturer - String
|
|
vaccine - String
|
|
lotNo - String
|
|
expDate - datetime
|
|
dose - Decimal
|
|
customDoseUnit - String
|
|
route - MedRouteEnum
|
|
freq - String
|
|
duration - Int
|
|
durUnit - DurationUnitEnum
|
|
refills - Int
|
|
beforeDatetime - datetime
|
|
fulfill - PrescriptionFulfillEnum
|
|
deactivatePatientOnCheckout - Boolean
|
|
spayPatientOnCheckout - Boolean
|
|
labCat - LabCategory
|
|
labCode - String
|
|
labDevice - String
|
|
labVendor - LabVendor
|
|
xrayVendor - XrayVendor
|
|
xrayModality - String
|
|
inventoryEnabled - Boolean
|
|
inventoryTreatmentId - ID
|
|
multiplier - Decimal
|
|
treatmentInventoryOptionEnabled - Boolean
|
|
compoundInventoryItems - [CompoundInventoryItemCreateSchema!]
|
|
vetcoveEnabled - Boolean
|
|
minimumQuantity - Decimal
|
|
priceType - PriceTypeEnum!
|
|
markupFactor - Decimal
|
|
useHistoricalHigh - Boolean
|
|
discountRates - [DiscountRateCreateSchema!]!
|
|
dischargeDocuments - [DischargeDocumentCreateSchema!]
|
|
clinicCostPerUnit - Int
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
Example
{
"name": "xyz789",
"type": "xyz789",
"typeCode": "abc123",
"category": "abc123",
"categoryCode": "abc123",
"subCategory": "abc123",
"subCategoryCode": "xyz789",
"unit": "ML",
"pricePerUnit": 123,
"minimumCharge": 987,
"adminFee": 123,
"isTaxable": false,
"isPstTaxable": true,
"isDiscountable": true,
"isControlledSubstance": true,
"instructions": "xyz789",
"inventoryHistoricalHighCostPerUnit": 123,
"inventoryLatestCostPerUnit": 123,
"species": "xyz789",
"manufacturer": "xyz789",
"vaccine": "xyz789",
"lotNo": "xyz789",
"expDate": datetime,
"dose": Decimal,
"customDoseUnit": "xyz789",
"route": "ORAL",
"freq": "xyz789",
"duration": 987,
"durUnit": "MINUTES",
"refills": 987,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"deactivatePatientOnCheckout": true,
"spayPatientOnCheckout": true,
"labCat": "IN_HOUSE",
"labCode": "abc123",
"labDevice": "abc123",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "xyz789",
"inventoryEnabled": true,
"inventoryTreatmentId": "4",
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": true,
"compoundInventoryItems": [
CompoundInventoryItemCreateSchema
],
"vetcoveEnabled": true,
"minimumQuantity": Decimal,
"priceType": "FIXED",
"markupFactor": Decimal,
"useHistoricalHigh": true,
"discountRates": [DiscountRateCreateSchema],
"dischargeDocuments": [DischargeDocumentCreateSchema],
"clinicCostPerUnit": 123,
"useVendorCost": true,
"vendorListPrice": 123
}
TreatmentLinkInput
TreatmentPlanCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID!
|
Reference to the patient receiving treatment (ClinicPatient model) |
clientId - ID
|
Reference to the client/pet owner (ClinicUser model). Default = null |
providerId - ID
|
Reference to the veterinarian overseeing the treatment plan (ClinicUser model). Default = null |
techUid - ID
|
Reference to the technician executing the treatment plan (ClinicUser model). Default = null |
treatments - [PrescribedTreatmentUpdateSchema!]
|
List of prescribed treatments with quantities, instructions, and scheduling. Default = [] |
tasks - [TreatmentPlanTaskUpdateSchema!]
|
List of non-treatment tasks associated with this plan. Default = [] |
description - String
|
Optional description or notes about the overall treatment plan. Default = null |
Example
{
"patientId": 4,
"clientId": 4,
"providerId": "4",
"techUid": 4,
"treatments": [PrescribedTreatmentUpdateSchema],
"tasks": [TreatmentPlanTaskUpdateSchema],
"description": "abc123"
}
TreatmentPlanOriginType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SOAP"
TreatmentPlanSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
patientId - ID!
|
Reference to the patient receiving treatment (ClinicPatient model) |
clientId - ID
|
Reference to the client/pet owner (ClinicUser model) |
providerId - ID
|
Reference to the veterinarian overseeing the treatment plan (ClinicUser model) |
techUid - ID
|
Reference to the technician executing the treatment plan (ClinicUser model) |
treatments - [PrescribedTreatmentSchema!]!
|
List of prescribed treatments with quantities, instructions, and scheduling |
tasks - [TreatmentPlanTaskSchema!]!
|
List of non-treatment tasks associated with this plan |
description - String
|
Optional description or notes about the overall treatment plan |
status - TreatmentPlanStatus!
|
Current status of the treatment plan (ongoing, ready for checkout, checked out) |
originId - ID
|
Reference to the originating medical record (SOAP, Surgery, or Visit Note) |
originType - TreatmentPlanOriginType
|
Type of medical record that created this treatment plan |
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": 4,
"patientId": "4",
"clientId": 4,
"providerId": "4",
"techUid": "4",
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "abc123",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
TreatmentPlanStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ONGOING"
TreatmentPlanTaskSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
description - String
|
|
scheduledEvents - [ScheduledEventSchema!]
|
Example
{
"id": "xyz789",
"name": "abc123",
"description": "abc123",
"scheduledEvents": [ScheduledEventSchema]
}
TreatmentPlanTaskUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - String
|
|
name - String
|
|
description - String
|
|
scheduledEvents - [ScheduledEventUpdateSchema!]
|
Example
{
"id": "xyz789",
"name": "abc123",
"description": "xyz789",
"scheduledEvents": [ScheduledEventUpdateSchema]
}
TreatmentPlanUpdateSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
patientId - ID
|
|
clientId - ID
|
|
providerId - ID
|
|
techUid - ID
|
|
status - TreatmentPlanStatus
|
|
treatments - [PrescribedTreatmentUpdateSchema!]
|
|
tasks - [TreatmentPlanTaskUpdateSchema!]
|
|
description - String
|
Example
{
"id": 4,
"patientId": 4,
"clientId": "4",
"providerId": "4",
"techUid": "4",
"status": "ONGOING",
"treatments": [PrescribedTreatmentUpdateSchema],
"tasks": [TreatmentPlanTaskUpdateSchema],
"description": "abc123"
}
TreatmentPlanViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ObjectIdFilter
|
|
status - StrFilter
|
Example
{
"patientId": ObjectIdFilter,
"status": StrFilter
}
TreatmentPlanViewSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
patient - PatientSchema!
|
|
provider - ClinicUserSchema
|
|
client - ClinicUserSchema
|
|
patientId - ID
|
|
clientId - ID
|
|
providerId - ID
|
|
techUid - ID
|
|
treatments - [PrescribedTreatmentSchema!]
|
|
tasks - [TreatmentPlanTaskSchema!]
|
|
description - String!
|
|
status - TreatmentPlanStatus!
|
|
originId - ID
|
|
originType - TreatmentPlanOriginType
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"id": "abc123",
"patient": PatientSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"patientId": "4",
"clientId": "4",
"providerId": "4",
"techUid": "4",
"treatments": [PrescribedTreatmentSchema],
"tasks": [TreatmentPlanTaskSchema],
"description": "xyz789",
"status": "ONGOING",
"originId": "4",
"originType": "SOAP",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
TreatmentQueryFilter
Fields
| Input Field | Description |
|---|---|
name - StrFilter
|
|
type - StrFilter
|
|
category - StrFilter
|
|
isControlledSubstance - BoolFilter
|
|
isProvisional - BoolFilter
|
Example
{
"name": StrFilter,
"type": StrFilter,
"category": StrFilter,
"isControlledSubstance": BoolFilter,
"isProvisional": BoolFilter
}
TreatmentReminderGenerateCreateSchema
TreatmentReminderGenerateSchema
TreatmentReminderSatisfyCreateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - String
|
Example
{"treatmentId": "abc123"}
TreatmentReminderSatisfySchema
Fields
| Field Name | Description |
|---|---|
treatmentId - String
|
Example
{"treatmentId": "xyz789"}
TreatmentSchema
Fields
| Field Name | Description |
|---|---|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
treatmentId - ID!
|
|
name - String!
|
Name of the treatment/service/medication |
unit - UnitEnum!
|
Unit of measurement (items, ml, mg, etc.) |
pricePerUnit - Int!
|
Base price per unit in cents |
instructions - String
|
Default instructions for administration or use |
adminFee - Int!
|
Additional administration fee in cents |
minimumCharge - Int!
|
Minimum charge in cents regardless of quantity |
customDoseUnit - String
|
Custom dose unit for prescriptions (e.g., 'tablets') |
duration - Int
|
Default duration of treatment in time units |
durUnit - DurationUnitEnum
|
Unit for duration (days, weeks, months) |
refills - Int
|
Default number of refills allowed for prescriptions |
beforeDatetime - datetime
|
Must be administered before this date/time |
fulfill - PrescriptionFulfillEnum
|
How prescription should be fulfilled (in-house, pharmacy, give script) |
markupFactor - Decimal
|
Markup factor for cost-plus pricing |
priceType - PriceTypeEnum
|
Pricing method (fixed, markup, markup from cost) |
dischargeDocumentIds - [ID!]!
|
List of discharge document IDs associated with this treatment |
type - String!
|
High-level treatment type (e.g., 'Medication', 'Surgery', 'Lab') |
typeCode - String!
|
Numeric code for treatment type (e.g., '5100' for pharmacy) |
category - String
|
Treatment category within type (e.g., 'Antibiotics') |
categoryCode - String
|
Numeric code for treatment category |
subCategory - String
|
More specific subcategory (e.g., 'Penicillins') |
subCategoryCode - String
|
Numeric code for treatment subcategory |
isTaxable - Boolean!
|
Whether this treatment is subject to sales tax |
isPstTaxable - Boolean
|
Whether this treatment is subject to secondary/additional tax (e.g., PST in Canada, other regional taxes) |
isDiscountable - Boolean
|
Whether discounts can be applied to this treatment |
isControlledSubstance - Boolean!
|
Whether this is a controlled substance requiring special handling |
generateReminders - [TreatmentReminderGenerateSchema!]
|
List of treatments that should generate reminders when this is used |
satisfyReminders - [TreatmentReminderSatisfySchema!]
|
List of treatments that satisfy/cancel reminders when this is used |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
deletedAt - datetime
|
Soft deletion timestamp - when set, treatment is considered deleted |
deactivatePatientOnCheckout - Boolean
|
Whether to mark patient as inactive when this treatment is invoiced |
spayPatientOnCheckout - Boolean
|
Whether to mark patient as spayed when this treatment is invoiced |
useHistoricalHigh - Boolean!
|
Use historical high cost for markup calculations instead of current cost |
discountRates - [DiscountRateSchema!]
|
Quantity-based discount tiers for this treatment |
isProvisional - Boolean!
|
Whether this treatment was auto-generated and needs staff review |
useAsDefaultNoProvisional - Boolean!
|
Whether to use this treatment instead of auto-generating provisional ones |
labCat - LabCategory
|
Laboratory category (in-house or reference lab) |
labCode - String
|
Laboratory test code for ordering and results |
labDevice - String
|
Laboratory device or analyzer used for testing |
labVendor - LabVendor
|
Laboratory vendor/provider (IDEXX, Zoetis, etc.) |
xrayVendor - XrayVendor
|
X-ray vendor/provider (IDEXX, SoundVet, etc.) |
xrayModality - String
|
X-ray modality type (radiography, ultrasound, etc.) |
inventoryEnabled - Boolean!
|
Whether this treatment tracks inventory quantities |
inventoryTreatmentId - ID
|
Reference to linked inventory treatment for quantity deduction (Treatment model). DEPRECATED: Use compound_inventory_items instead. |
multiplier - Decimal
|
Quantity multiplier for inventory deduction when this treatment is used. DEPRECATED: Use compound_inventory_items instead. |
treatmentInventoryOptionEnabled - Boolean!
|
Whether this treatment is linked to another treatment's inventory |
compoundInventoryItems - [CompoundInventoryItemSchema!]
|
List of inventory items to deduct when this compound treatment is used |
vetcoveEnabled - Boolean!
|
Whether this treatment is available for Vetcove ordering |
minimumQuantity - Decimal
|
Minimum quantity threshold before low stock alerts |
quantityRemaining - Decimal
|
CACHED: Current inventory quantity remaining (auto-updated) |
furthestExpiredAt - String
|
CACHED: Expiration date of oldest inventory lot (auto-updated) |
inventoryHistoricalHighCostPerUnit - Int!
|
CACHED: Historical highest cost per unit in cents (auto-updated) |
inventoryLatestCostPerUnit - Int!
|
CACHED: Most recent cost per unit in cents (auto-updated) |
clinicCostPerUnit - Int
|
Clinic's cost per unit in cents (for profit calculations) |
useVendorCost - Boolean
|
Whether to use vendor cost for markup calculations |
vendorListPrice - Int
|
Vendor's list price per unit in cents |
route - MedRouteEnum
|
|
freq - String
|
|
manufacturer - String
|
|
vaccine - String
|
|
lotNo - String
|
|
expDate - datetime
|
|
species - String
|
|
dose - Decimal
|
Example
{
"dischargeDocuments": [DischargeDocumentSchema],
"treatmentId": "4",
"name": "abc123",
"unit": "ML",
"pricePerUnit": 123,
"instructions": "xyz789",
"adminFee": 123,
"minimumCharge": 123,
"customDoseUnit": "xyz789",
"duration": 987,
"durUnit": "MINUTES",
"refills": 123,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"markupFactor": Decimal,
"priceType": "FIXED",
"dischargeDocumentIds": [4],
"type": "xyz789",
"typeCode": "xyz789",
"category": "xyz789",
"categoryCode": "xyz789",
"subCategory": "abc123",
"subCategoryCode": "abc123",
"isTaxable": true,
"isPstTaxable": false,
"isDiscountable": true,
"isControlledSubstance": false,
"generateReminders": [TreatmentReminderGenerateSchema],
"satisfyReminders": [TreatmentReminderSatisfySchema],
"createdAt": datetime,
"updatedAt": datetime,
"deletedAt": datetime,
"deactivatePatientOnCheckout": false,
"spayPatientOnCheckout": false,
"useHistoricalHigh": true,
"discountRates": [DiscountRateSchema],
"isProvisional": false,
"useAsDefaultNoProvisional": true,
"labCat": "IN_HOUSE",
"labCode": "abc123",
"labDevice": "abc123",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "xyz789",
"inventoryEnabled": false,
"inventoryTreatmentId": 4,
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": false,
"compoundInventoryItems": [CompoundInventoryItemSchema],
"vetcoveEnabled": true,
"minimumQuantity": Decimal,
"quantityRemaining": Decimal,
"furthestExpiredAt": "abc123",
"inventoryHistoricalHighCostPerUnit": 123,
"inventoryLatestCostPerUnit": 987,
"clinicCostPerUnit": 123,
"useVendorCost": false,
"vendorListPrice": 987,
"route": "ORAL",
"freq": "abc123",
"manufacturer": "xyz789",
"vaccine": "abc123",
"lotNo": "abc123",
"expDate": datetime,
"species": "abc123",
"dose": Decimal
}
TreatmentSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [TreatmentSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [TreatmentSchemaEdge]
}
TreatmentSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - TreatmentSchema!
|
|
cursor - String!
|
Example
{
"node": TreatmentSchema,
"cursor": "xyz789"
}
TreatmentSearchResultSchema
Fields
| Field Name | Description |
|---|---|
node - TreatmentSchema!
|
|
highlights - [HighlightSchema!]
|
|
score - Float
|
Example
{
"node": TreatmentSchema,
"highlights": [HighlightSchema],
"score": 123.45
}
TreatmentSubCategorySchema
TreatmentSubCategoryUpdateSchema
TreatmentTypeSchema
Fields
| Field Name | Description |
|---|---|
type - String!
|
|
typeCode - String!
|
|
locked - Boolean!
|
|
categories - [TreatmentCategorySchema!]
|
Example
{
"type": "xyz789",
"typeCode": "xyz789",
"locked": true,
"categories": [TreatmentCategorySchema]
}
TreatmentTypeUpdateSchema
Fields
| Input Field | Description |
|---|---|
type - String
|
|
typeCode - String
|
|
locked - Boolean
|
|
categories - [TreatmentCategoryUpdateSchema!]
|
Example
{
"type": "xyz789",
"typeCode": "xyz789",
"locked": false,
"categories": [TreatmentCategoryUpdateSchema]
}
TreatmentUpdateSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ID!
|
|
name - String
|
|
type - String
|
|
typeCode - String
|
|
category - String
|
|
categoryCode - String
|
|
subCategory - String
|
|
subCategoryCode - String
|
|
instructions - String
|
|
unit - UnitEnum
|
|
pricePerUnit - Int
|
|
minimumCharge - Int
|
|
adminFee - Int
|
|
isTaxable - Boolean
|
|
isPstTaxable - Boolean
|
|
isDiscountable - Boolean
|
|
isControlledSubstance - Boolean
|
|
inventoryEnabled - Boolean
|
|
inventoryTreatmentId - ID
|
|
multiplier - Decimal
|
|
treatmentInventoryOptionEnabled - Boolean
|
|
compoundInventoryItems - [CompoundInventoryItemCreateSchema!]
|
|
vetcoveEnabled - Boolean
|
|
minimumQuantity - Decimal
|
|
generateReminders - [TreatmentReminderGenerateCreateSchema!]
|
|
satisfyReminders - [TreatmentReminderSatisfyCreateSchema!]
|
|
species - String
|
|
manufacturer - String
|
|
vaccine - String
|
|
lotNo - String
|
|
expDate - datetime
|
|
updatedAt - datetime
|
|
dose - Decimal
|
|
customDoseUnit - String
|
|
route - MedRouteEnum
|
|
freq - String
|
|
duration - Int
|
|
durUnit - DurationUnitEnum
|
|
refills - Int
|
|
beforeDatetime - datetime
|
|
fulfill - PrescriptionFulfillEnum
|
|
deactivatePatientOnCheckout - Boolean
|
|
spayPatientOnCheckout - Boolean
|
|
useAsDefaultNoProvisional - Boolean
|
|
labCat - LabCategory
|
|
labCode - String
|
|
labDevice - String
|
|
labVendor - LabVendor
|
|
xrayVendor - XrayVendor
|
|
xrayModality - String
|
|
priceType - PriceTypeEnum
|
|
markupFactor - Decimal
|
|
useHistoricalHigh - Boolean
|
|
discountRates - [DiscountRateCreateSchema!]
|
|
dischargeDocuments - [DischargeDocumentUpdateSchema!]
|
|
clinicCostPerUnit - Int
|
|
useVendorCost - Boolean
|
|
vendorListPrice - Int
|
Example
{
"treatmentId": "4",
"name": "xyz789",
"type": "xyz789",
"typeCode": "abc123",
"category": "xyz789",
"categoryCode": "abc123",
"subCategory": "abc123",
"subCategoryCode": "xyz789",
"instructions": "abc123",
"unit": "ML",
"pricePerUnit": 123,
"minimumCharge": 987,
"adminFee": 123,
"isTaxable": false,
"isPstTaxable": true,
"isDiscountable": true,
"isControlledSubstance": false,
"inventoryEnabled": true,
"inventoryTreatmentId": "4",
"multiplier": Decimal,
"treatmentInventoryOptionEnabled": true,
"compoundInventoryItems": [
CompoundInventoryItemCreateSchema
],
"vetcoveEnabled": true,
"minimumQuantity": Decimal,
"generateReminders": [
TreatmentReminderGenerateCreateSchema
],
"satisfyReminders": [
TreatmentReminderSatisfyCreateSchema
],
"species": "abc123",
"manufacturer": "xyz789",
"vaccine": "xyz789",
"lotNo": "xyz789",
"expDate": datetime,
"updatedAt": datetime,
"dose": Decimal,
"customDoseUnit": "abc123",
"route": "ORAL",
"freq": "xyz789",
"duration": 987,
"durUnit": "MINUTES",
"refills": 123,
"beforeDatetime": datetime,
"fulfill": "IN_HOUSE",
"deactivatePatientOnCheckout": false,
"spayPatientOnCheckout": true,
"useAsDefaultNoProvisional": true,
"labCat": "IN_HOUSE",
"labCode": "abc123",
"labDevice": "abc123",
"labVendor": "OTHER",
"xrayVendor": "OTHER",
"xrayModality": "abc123",
"priceType": "FIXED",
"markupFactor": Decimal,
"useHistoricalHigh": false,
"discountRates": [DiscountRateCreateSchema],
"dischargeDocuments": [DischargeDocumentUpdateSchema],
"clinicCostPerUnit": 123,
"useVendorCost": true,
"vendorListPrice": 123
}
TriggerInputSchema
Fields
| Input Field | Description |
|---|---|
type - TriggerType!
|
|
operator - ConditionOperator!
|
|
conditions - WorkflowAutomationConditionsInput!
|
Example
{
"type": "APPOINTMENT_CREATED",
"operator": "EQUALS",
"conditions": WorkflowAutomationConditionsInput
}
TriggerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPOINTMENT_CREATED"
UnifiedSearchFilter
Fields
| Input Field | Description |
|---|---|
patientFilter - PatientUnifiedFilter
|
Example
{"patientFilter": PatientUnifiedFilter}
UnifiedSearchMetadataSchema
UnifiedSearchResponseSchema
Fields
| Field Name | Description |
|---|---|
patientResults - [PatientSearchResultSchema!]!
|
|
clientResults - [ClientSearchResultSchema!]!
|
|
treatmentResults - [TreatmentSearchResultSchema!]!
|
|
bundleResults - [BundleSearchResultSchema!]!
|
|
metadata - UnifiedSearchMetadataSchema!
|
Example
{
"patientResults": [PatientSearchResultSchema],
"clientResults": [ClientSearchResultSchema],
"treatmentResults": [TreatmentSearchResultSchema],
"bundleResults": [BundleSearchResultSchema],
"metadata": UnifiedSearchMetadataSchema
}
UnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ML"
UnlinkProviderInput
Fields
| Input Field | Description |
|---|---|
employeeId - ID!
|
|
labVendor - LabVendor!
|
Example
{"employeeId": 4, "labVendor": "OTHER"}
UpdateRecurringMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"THIS_EVENT_ONLY"
UpdateScheduledEventSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
instanceId - ID
|
|
treatmentPlanTaskId - String
|
|
scheduleType - ScheduledEventType!
|
|
startDatetime - datetime
|
|
status - ScheduledEventStatus
|
|
doneAt - datetime
|
|
doneBy - ID
|
|
instructions - String
|
Example
{
"id": "4",
"instanceId": 4,
"treatmentPlanTaskId": "xyz789",
"scheduleType": "SCHEDULED",
"startDatetime": datetime,
"status": "SCHEDULED",
"doneAt": datetime,
"doneBy": 4,
"instructions": "xyz789"
}
UpdateSubscriptionInput
Example
{
"subscriptionId": "xyz789",
"price": 123,
"paymentMethodId": "abc123",
"metadata": {},
"platformFeeAmount": 987,
"cancelAt": datetime,
"pauseAt": datetime,
"resumeAt": datetime
}
UpdatedOrderNoteResponse
Fields
| Field Name | Description |
|---|---|
updatedOrderNote - OrderNoteSchema!
|
|
syncedInvoice - InvoiceSchema
|
Example
{
"updatedOrderNote": OrderNoteSchema,
"syncedInvoice": InvoiceSchema
}
UpdatedSoapResponse
Fields
| Field Name | Description |
|---|---|
updatedSoap - SoapSchema!
|
|
syncedInvoice - InvoiceSchema
|
Example
{
"updatedSoap": SoapSchema,
"syncedInvoice": InvoiceSchema
}
UpdatedSurgeryNoteResponse
Fields
| Field Name | Description |
|---|---|
updatedSurgery - SurgerySchema!
|
|
syncedInvoice - InvoiceSchema
|
Example
{
"updatedSurgery": SurgerySchema,
"syncedInvoice": InvoiceSchema
}
UpdatedVisitNoteResponse
Fields
| Field Name | Description |
|---|---|
updatedVisitNote - VisitNoteSchema!
|
|
syncedInvoice - InvoiceSchema
|
Example
{
"updatedVisitNote": VisitNoteSchema,
"syncedInvoice": InvoiceSchema
}
UserGender
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FEMALE"
UserStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
UsersCommissionSchema
Example
{
"treatment": TreatmentSchema,
"id": 4,
"userId": 4,
"invoiceId": 4,
"treatmentId": "4",
"revenue": 987,
"commissionRate": 987.65,
"commissionAmount": 987,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"voidedAt": datetime
}
UsersCommissionViewFilterSchema
Fields
| Input Field | Description |
|---|---|
userId - ListObjectIdFilter
|
|
createdAt - DateFilter
|
Example
{
"userId": ListObjectIdFilter,
"createdAt": DateFilter
}
UsersCommissionViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
userId - ID
|
|
user - ClinicUserSchema
|
|
invoiceId - ID
|
|
invoice - InvoiceSchema
|
|
treatmentId - ID
|
|
treatment - TreatmentSchema
|
|
revenue - Int!
|
|
commissionRate - Float!
|
|
commissionAmount - Int!
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
voidedAt - datetime
|
Example
{
"id": "4",
"userId": "4",
"user": ClinicUserSchema,
"invoiceId": "4",
"invoice": InvoiceSchema,
"treatmentId": "4",
"treatment": TreatmentSchema,
"revenue": 123,
"commissionRate": 123.45,
"commissionAmount": 123,
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"voidedAt": datetime
}
UsersCommissionViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [UsersCommissionViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [UsersCommissionViewSchemaEdge]
}
UsersCommissionViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - UsersCommissionViewSchema!
|
|
cursor - String!
|
Example
{
"node": UsersCommissionViewSchema,
"cursor": "abc123"
}
VaccineCertificateTodoSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completed - Boolean!
|
Tracks whether this checkout task has been completed by the clinic staff. Automatically set to True when related entities (vaccines, rx scripts) are created |
todoType - TodoType!
|
Discriminator field for polymorphic todo type selection. Must be overridden in subclasses with specific todo type values |
treatmentName - String!
|
Display name of the vaccine treatment from the Treatment model. Used to identify which vaccine certificate needs to be created |
vaccineId - ID
|
Reference to created vaccine record (Vaccine model). Populated when vaccine certificate is generated, indicates completion |
soapId - ID
|
Reference to the medical record (Soap model) requiring this vaccine certificate. Required to link vaccine certificate to the correct appointment |
Example
{
"id": "4",
"completed": true,
"todoType": "VACCINE_CERTIFICATE",
"treatmentName": "xyz789",
"vaccineId": "4",
"soapId": 4
}
VaccineCreateSchema
Fields
| Input Field | Description |
|---|---|
status - VaccineStatusEnum
|
|
patientId - ID!
|
|
creatorUid - ID
|
|
item - VaccineItemCreateSchema!
|
|
vaccinationDate - datetime
|
|
approved - Boolean
|
|
declined - Boolean
|
|
expDate - datetime
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
clientId - ID
|
|
invoiceId - ID
|
|
tagNumber - String
|
|
previousTagNumber - String
|
|
approverId - ID
|
|
approverName - String
|
|
approverLicense - String
|
|
originalVaccineId - ID
|
Example
{
"status": "OPEN",
"patientId": 4,
"creatorUid": "4",
"item": VaccineItemCreateSchema,
"vaccinationDate": datetime,
"approved": true,
"declined": false,
"expDate": datetime,
"soapId": 4,
"surgeryId": 4,
"visitNoteId": "4",
"orderNoteId": "4",
"clientId": 4,
"invoiceId": "4",
"tagNumber": "abc123",
"previousTagNumber": "abc123",
"approverId": "4",
"approverName": "abc123",
"approverLicense": "abc123",
"originalVaccineId": 4
}
VaccineFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
clientId - ListObjectIdFilter
|
|
approverId - ObjectIdFilter
|
|
treatmentId - ListObjectIdFilter
|
|
tagNumber - StrFilter
|
|
previousTagNumber - StrFilter
|
|
vaccinationDate - DateFilter
|
|
expDate - DateFilter
|
|
status - StrFilter
|
|
lotNo - StrFilter
|
|
serialNo - StrFilter
|
|
itemDotName - StrFilter
|
|
createdAt - DateFilter
|
Example
{
"patientId": ListObjectIdFilter,
"clientId": ListObjectIdFilter,
"approverId": ObjectIdFilter,
"treatmentId": ListObjectIdFilter,
"tagNumber": StrFilter,
"previousTagNumber": StrFilter,
"vaccinationDate": DateFilter,
"expDate": DateFilter,
"status": StrFilter,
"lotNo": StrFilter,
"serialNo": StrFilter,
"itemDotName": StrFilter,
"createdAt": DateFilter
}
VaccineItemCreateSchema
Example
{
"treatmentId": "4",
"instanceId": 4,
"name": "xyz789",
"unit": "xyz789",
"pricePerUnit": 987,
"qty": Decimal,
"species": "xyz789",
"manufacturer": "xyz789",
"vaccine": "abc123",
"lotNo": "xyz789",
"serialNo": "abc123",
"expDate": "xyz789",
"clinicCostPerUnit": 123
}
VaccineItemSchema
Fields
| Field Name | Description |
|---|---|
treatment - TreatmentSchema
|
|
name - String
|
Name of the vaccine product |
unit - String
|
Unit of measurement (typically doses) |
pricePerUnit - Int
|
Price per unit in cents |
clinicCostPerUnit - Int
|
Clinic's cost per unit in cents |
qty - Decimal
|
Quantity administered |
treatmentId - ID
|
Reference to the associated treatment (Treatment model) |
instanceId - ID
|
Unique identifier for this specific prescribed instance - tracks from medical note to invoice to vaccine. None for legacy vaccines created before instance tracking. |
species - String
|
Target animal species for this vaccine |
manufacturer - String
|
Vaccine manufacturer name |
vaccine - String
|
Specific vaccine product name |
lotNo - String
|
Manufacturing lot number for tracking |
serialNo - String
|
Serial number for individual dose tracking |
expDate - String
|
Vaccine expiration date |
Example
{
"treatment": TreatmentSchema,
"name": "abc123",
"unit": "abc123",
"pricePerUnit": 123,
"clinicCostPerUnit": 987,
"qty": Decimal,
"treatmentId": "4",
"instanceId": 4,
"species": "xyz789",
"manufacturer": "xyz789",
"vaccine": "abc123",
"lotNo": "xyz789",
"serialNo": "abc123",
"expDate": "xyz789"
}
VaccineItemUpdateSchema
Example
{
"treatmentId": "4",
"instanceId": 4,
"name": "xyz789",
"unit": "abc123",
"pricePerUnit": 123,
"qty": Decimal,
"species": "abc123",
"manufacturer": "xyz789",
"vaccine": "xyz789",
"lotNo": "xyz789",
"serialNo": "abc123",
"expDate": "abc123",
"clinicCostPerUnit": 123
}
VaccineSchema
Fields
| Field Name | Description |
|---|---|
media - MediaSchema
|
|
vaccineId - ID!
|
|
status - VaccineStatusEnum
|
Current status of the vaccine record (open, locked, voided, deleted) |
patientId - ID!
|
Reference to the patient who received the vaccine (ClinicPatient model) |
creatorUid - ID
|
Reference to the user who created this vaccine record (ClinicUser model) |
item - VaccineItemSchema!
|
Vaccine product details and administration info |
approved - Boolean!
|
Whether the vaccine has been approved by a licensed veterinarian |
declined - Boolean
|
Whether the vaccine has been declined by the client or veterinarian |
vaccinationDate - String
|
Date when the vaccine was administered |
expDate - String
|
Expiration date of the vaccine lot used |
soapId - ID
|
Reference to associated SOAP note (Soap model) |
surgeryId - ID
|
Reference to associated surgery record (Surgery model) |
visitNoteId - ID
|
Reference to associated visit note (VisitNote model) |
orderNoteId - ID
|
Reference to associated order note (OrderNote model) |
invoiceId - ID
|
|
clientId - ID
|
Reference to the client/pet owner (ClinicUser model) |
tagNumber - String
|
Official tag number issued for this vaccination |
previousTagNumber - String
|
Previous tag number if this is a replacement |
approverId - ID
|
Reference to the veterinarian who approved this vaccine (ClinicUser model) |
approverName - String
|
Name of the approving veterinarian |
approverLicense - String
|
License number of the approving veterinarian |
signature - String
|
Base64 encoded digital signature image |
mediaRef - ID
|
Reference to any associated media files (Media model) |
originalVaccineId - ID
|
Links to original vaccine if this is an edit |
createdAt - String
|
|
updatedAt - String
|
Example
{
"media": MediaSchema,
"vaccineId": "4",
"status": "OPEN",
"patientId": 4,
"creatorUid": "4",
"item": VaccineItemSchema,
"approved": true,
"declined": false,
"vaccinationDate": "abc123",
"expDate": "xyz789",
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"invoiceId": 4,
"clientId": "4",
"tagNumber": "xyz789",
"previousTagNumber": "xyz789",
"approverId": "4",
"approverName": "xyz789",
"approverLicense": "xyz789",
"signature": "xyz789",
"mediaRef": 4,
"originalVaccineId": 4,
"createdAt": "abc123",
"updatedAt": "abc123"
}
VaccineStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
VaccineUpdateSchema
Fields
| Input Field | Description |
|---|---|
vaccineId - ID!
|
|
patientId - ID
|
|
creatorUid - ID
|
|
status - VaccineStatusEnum
|
|
item - VaccineItemUpdateSchema
|
|
vaccinationDate - datetime
|
|
approved - Boolean
|
|
declined - Boolean
|
|
expDate - datetime
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
invoiceId - ID
|
|
clientId - ID
|
|
tagNumber - String
|
|
previousTagNumber - String
|
|
approverId - ID
|
|
approverName - String
|
|
approverLicense - String
|
|
signature - String
|
|
mediaRef - ID
|
|
originalVaccineId - ID
|
Example
{
"vaccineId": "4",
"patientId": 4,
"creatorUid": 4,
"status": "OPEN",
"item": VaccineItemUpdateSchema,
"vaccinationDate": datetime,
"approved": false,
"declined": true,
"expDate": datetime,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"invoiceId": "4",
"clientId": "4",
"tagNumber": "xyz789",
"previousTagNumber": "abc123",
"approverId": 4,
"approverName": "abc123",
"approverLicense": "abc123",
"signature": "abc123",
"mediaRef": 4,
"originalVaccineId": "4"
}
VaccineViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
patientId - ID!
|
|
item - VaccineItemSchema
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
status - VaccineStatusEnum!
|
|
creatorUid - ID
|
|
clientId - ID
|
|
treatmentId - ID
|
|
soapId - ID
|
|
surgeryId - ID
|
|
visitNoteId - ID
|
|
orderNoteId - ID
|
|
invoiceId - ID
|
|
vaccineId - ID
|
|
instanceId - ID
|
|
approverId - ID
|
|
tagNumber - String
|
|
previousTagNumber - String
|
|
approverName - String
|
|
approverLicense - String
|
|
approved - Boolean
|
|
declined - Boolean
|
|
vaccinationDate - datetime
|
|
expDate - datetime
|
|
mediaRef - ID
|
|
originalVaccineId - ID
|
|
patient - PatientSchema
|
|
media - MediaSchema
|
|
soap - SoapSchema
|
|
approver - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
client - ClinicUserSchema
|
|
lotNo - String
|
|
serialNo - String
|
|
patientFirstNameLowercase - String
|
|
clientLastNameLowercase - String
|
|
approverLastNameLowercase - String
|
Example
{
"id": 4,
"patientId": "4",
"item": VaccineItemSchema,
"createdAt": datetime,
"updatedAt": datetime,
"status": "OPEN",
"creatorUid": "4",
"clientId": "4",
"treatmentId": 4,
"soapId": "4",
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": 4,
"invoiceId": 4,
"vaccineId": 4,
"instanceId": 4,
"approverId": 4,
"tagNumber": "xyz789",
"previousTagNumber": "xyz789",
"approverName": "abc123",
"approverLicense": "xyz789",
"approved": false,
"declined": true,
"vaccinationDate": datetime,
"expDate": datetime,
"mediaRef": 4,
"originalVaccineId": 4,
"patient": PatientSchema,
"media": MediaSchema,
"soap": SoapSchema,
"approver": ClinicUserSchema,
"provider": ClinicUserSchema,
"client": ClinicUserSchema,
"lotNo": "abc123",
"serialNo": "abc123",
"patientFirstNameLowercase": "abc123",
"clientLastNameLowercase": "xyz789",
"approverLastNameLowercase": "abc123"
}
VaccineViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [VaccineViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [VaccineViewSchemaEdge]
}
VaccineViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - VaccineViewSchema!
|
|
cursor - String!
|
Example
{
"node": VaccineViewSchema,
"cursor": "abc123"
}
VendorCreateSchema
Fields
| Input Field | Description |
|---|---|
name - String!
|
Company or organization name of the vendor |
contactName - String
|
Primary contact person's name at the vendor. Default = null |
contactEmail - String
|
Primary contact's email address for communication. Default = null |
vetcoveId - Int
|
External identifier from Vetcove integration system. Default = null |
type - VendorType
|
Classification of vendor relationship (manufacturer, distributor, etc). Default = null |
accountNumber - String
|
Clinic's account number or identifier with this vendor. Default = null |
website - String
|
Vendor's website URL for reference. Default = null |
Example
{
"name": "abc123",
"contactName": "xyz789",
"contactEmail": "xyz789",
"vetcoveId": 987,
"type": "MANUFACTURER",
"accountNumber": "abc123",
"website": "abc123"
}
VendorFilterSchema
VendorSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
MongoDB document ObjectID |
name - String!
|
Company or organization name of the vendor |
contactName - String
|
Primary contact person's name at the vendor |
contactEmail - String
|
Primary contact's email address for communication |
vetcoveId - Int
|
External identifier from Vetcove integration system |
type - VendorType
|
Classification of vendor relationship (manufacturer, distributor, etc) |
accountNumber - String
|
Clinic's account number or identifier with this vendor |
website - String
|
Vendor's website URL for reference |
deletedAt - datetime
|
Soft deletion timestamp - when set, vendor is considered deleted |
Example
{
"id": 4,
"name": "xyz789",
"contactName": "xyz789",
"contactEmail": "xyz789",
"vetcoveId": 123,
"type": "MANUFACTURER",
"accountNumber": "abc123",
"website": "abc123",
"deletedAt": datetime
}
VendorSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [VendorSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [VendorSchemaEdge]
}
VendorSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - VendorSchema!
|
|
cursor - String!
|
Example
{
"node": VendorSchema,
"cursor": "abc123"
}
VendorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MANUFACTURER"
VendorUpdateSchema
Example
{
"id": "4",
"name": "abc123",
"contactName": "xyz789",
"contactEmail": "xyz789",
"vetcoveId": 987,
"type": "MANUFACTURER",
"accountNumber": "xyz789",
"website": "xyz789",
"deletedAt": datetime
}
VetcoveClinicInfoSchema
VisitNoteCreateSchema
Example
{
"patientId": "4",
"creatorUid": 4,
"appointmentId": 4,
"appointmentTypeId": 4,
"providerId": "4",
"notes": "xyz789",
"details": "xyz789",
"assessment": SoapAssessmentCreateSchema,
"recs": "xyz789"
}
VisitNoteSchema
Fields
| Field Name | Description |
|---|---|
patientVitals - PatientVitalSchema
|
|
estimates - [EstimateSchema!]
|
|
invoices - [InvoiceViewSchema!]
|
|
vitals - [PatientVitalSchema!]
|
|
addendums - [AddendumSchema!]
|
|
media - [MediaSchema!]
|
|
creator - ClinicUserSchema
|
|
provider - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patient - PatientSchema!
|
|
appointmentType - AppointmentTypeResolveSchema
|
|
dischargeDocuments - [DischargeDocumentSchema!]
|
|
id - ID!
|
MongoDB document ObjectID |
noteType - NoteType
|
Determines the specific note type - affects display, validation, and auto-lock behavior. Each note type has different auto-lock timeouts and specific business logic |
patientId - ID!
|
Required reference to the patient this note belongs to (ClinicPatient model). Used for patient history tracking and medical record organization |
providerId - ID
|
The primary veterinary provider responsible for this note (ClinicUser model). Auto-populated from appointment assigned employee if they are a provider. Falls back to default vet assigned to patient for current day if no appointment |
creatorUid - ID
|
The user who originally created this note (ClinicUser model). Used for audit trails and permission checks |
techUid - ID
|
The veterinary technician associated with this note (ClinicUser model). Typically assigned during appointment scheduling or note creation |
appointmentId - ID
|
Reference to the appointment this note was created from (Appointment model). Used to inherit appointment details like assigned staff and appointment type |
appointmentTypeId - ID
|
Reference to the type of appointment this note relates to (AppointmentType model). Auto-populated from linked appointment for categorization and reporting |
treatments - [PrescribedTreatmentSchema!]
|
List of prescribed treatments, medications, and procedures for this note. Syncs to invoicing system when auto-charge capture is enabled. Each treatment includes quantity, instructions, pricing, and fulfillment details |
followUps - [FollowUpSchema!]
|
List of recommended follow-up appointments and care instructions. Each follow-up includes appointment type, reason, and recommended timing |
status - SoapStatusEnum
|
Current workflow status of the note - controls editability and triggers side effects. DRAFT: editable, auto-locks after clinic-configured hours. FINAL: locked, triggers patient history updates and patient annotation creation. VOIDED/DELETED: reverses patient annotations and marks as inactive |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
autolockCreatedAt - datetime
|
Optional reference datetime for auto-lock functionality. When set, this datetime is used instead of created_at for calculating auto-lock timing (autolock_created_at + autolock_hours). Allows for custom auto-lock reference timing per note |
patientDiagrams - [SoapSurgeryPatientDiagramSchema!]
|
List of patient body diagrams with annotations for visual medical documentation. When note is finalized, default body diagram annotations are copied to patient annotations. Supports multiple diagram types including body maps and custom medical illustrations |
vet - ClinicUserSchema
|
|
voiceNoteId - ID
|
|
notes - String
|
|
details - String
|
|
recs - String
|
|
assessment - SoapAssessmentSchema!
|
Example
{
"patientVitals": PatientVitalSchema,
"estimates": [EstimateSchema],
"invoices": [InvoiceViewSchema],
"vitals": [PatientVitalSchema],
"addendums": [AddendumSchema],
"media": [MediaSchema],
"creator": ClinicUserSchema,
"provider": ClinicUserSchema,
"tech": ClinicUserSchema,
"patient": PatientSchema,
"appointmentType": AppointmentTypeResolveSchema,
"dischargeDocuments": [DischargeDocumentSchema],
"id": 4,
"noteType": "SOAP",
"patientId": "4",
"providerId": 4,
"creatorUid": "4",
"techUid": "4",
"appointmentId": "4",
"appointmentTypeId": "4",
"treatments": [PrescribedTreatmentSchema],
"followUps": [FollowUpSchema],
"status": "DRAFT",
"createdAt": datetime,
"updatedAt": datetime,
"autolockCreatedAt": datetime,
"patientDiagrams": [SoapSurgeryPatientDiagramSchema],
"vet": ClinicUserSchema,
"voiceNoteId": "4",
"notes": "xyz789",
"details": "xyz789",
"recs": "xyz789",
"assessment": SoapAssessmentSchema
}
VisitNoteTemplateCreateSchema
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
creatorId - ID!
|
|
species - String!
|
|
appointmentTypeId - ID
|
|
visitNoteTemplateData - VisitNoteTemplateDataCreateSchema
|
Example
{
"name": "abc123",
"creatorId": "4",
"species": "abc123",
"appointmentTypeId": "4",
"visitNoteTemplateData": VisitNoteTemplateDataCreateSchema
}
VisitNoteTemplateDataCreateSchema
Fields
| Input Field | Description |
|---|---|
notes - String
|
|
details - String
|
|
recs - String
|
|
assessment - SoapAssessmentCreateSchema
|
|
treatmentIds - [ID!]
|
Example
{
"notes": "abc123",
"details": "abc123",
"recs": "xyz789",
"assessment": SoapAssessmentCreateSchema,
"treatmentIds": ["4"]
}
VisitNoteTemplateDataSchema
Fields
| Field Name | Description |
|---|---|
treatments - [TreatmentSchema!]
|
|
notes - String
|
|
details - String
|
|
recs - String
|
|
assessment - SoapAssessmentSchema
|
|
treatmentIds - [ID!]
|
Example
{
"treatments": [TreatmentSchema],
"notes": "xyz789",
"details": "xyz789",
"recs": "abc123",
"assessment": SoapAssessmentSchema,
"treatmentIds": ["4"]
}
VisitNoteTemplateDataUpdateSchema
Fields
| Input Field | Description |
|---|---|
notes - String
|
|
details - String
|
|
recs - String
|
|
assessment - SoapAssessmentUpdateSchema
|
|
treatmentIds - [ID!]
|
Example
{
"notes": "abc123",
"details": "abc123",
"recs": "abc123",
"assessment": SoapAssessmentUpdateSchema,
"treatmentIds": [4]
}
VisitNoteTemplateFilterSchema
Fields
| Input Field | Description |
|---|---|
deletedAt - StrFilter
|
|
creatorId - ObjectIdFilter
|
|
name - StrFilter
|
|
species - StrFilter
|
|
favoritedBy - ObjectIdFilter
|
|
isDeleted - BoolFilter
|
|
createdAt - DateFilter
|
Example
{
"deletedAt": StrFilter,
"creatorId": ObjectIdFilter,
"name": StrFilter,
"species": StrFilter,
"favoritedBy": ObjectIdFilter,
"isDeleted": BoolFilter,
"createdAt": DateFilter
}
VisitNoteTemplateSchema
Example
{
"id": 4,
"name": "xyz789",
"creatorId": 4,
"species": "xyz789",
"isDeleted": true,
"favoritedBy": ["4"],
"appointmentTypeId": 4,
"visitNoteTemplateData": VisitNoteTemplateDataSchema,
"createdAt": datetime,
"updatedAt": datetime
}
VisitNoteTemplateSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [VisitNoteTemplateSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [VisitNoteTemplateSchemaEdge]
}
VisitNoteTemplateSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - VisitNoteTemplateSchema!
|
|
cursor - String!
|
Example
{
"node": VisitNoteTemplateSchema,
"cursor": "xyz789"
}
VisitNoteTemplateToggleFavoriteSchema
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
action - ToggleActionEnum!
|
|
userId - ID
|
Example
{"id": 4, "action": "FAVORITE", "userId": 4}
VisitNoteTemplateUpdateSchema
Example
{
"id": 4,
"name": "xyz789",
"species": "xyz789",
"isDeleted": true,
"appointmentTypeId": 4,
"visitNoteTemplateData": VisitNoteTemplateDataUpdateSchema
}
VisitNoteUpdateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID
|
|
providerId - ID
|
|
techUid - ID
|
|
appointmentId - ID
|
|
appointmentTypeId - ID
|
|
treatments - [PrescribedTreatmentUpdateSchema!]
|
|
followUps - [FollowUpUpdateSchema!]
|
|
status - SoapStatusEnum
|
|
addendumIds - [ID!]
|
|
patientDiagrams - [SoapSurgeryPatientDiagramUpdateSchema!]
|
|
createdAt - datetime
|
|
autolockCreatedAt - datetime
|
|
voidReason - String
|
|
id - ID!
|
|
notes - String
|
|
details - String
|
|
assessment - SoapAssessmentUpdateSchema
|
|
voiceNoteId - ID
|
|
recs - String
|
Example
{
"patientId": 4,
"providerId": 4,
"techUid": 4,
"appointmentId": 4,
"appointmentTypeId": 4,
"treatments": [PrescribedTreatmentUpdateSchema],
"followUps": [FollowUpUpdateSchema],
"status": "DRAFT",
"addendumIds": [4],
"patientDiagrams": [
SoapSurgeryPatientDiagramUpdateSchema
],
"createdAt": datetime,
"autolockCreatedAt": datetime,
"voidReason": "abc123",
"id": "4",
"notes": "abc123",
"details": "xyz789",
"assessment": SoapAssessmentUpdateSchema,
"voiceNoteId": 4,
"recs": "abc123"
}
VisitNoteViewFilterSchema
Fields
| Input Field | Description |
|---|---|
patientId - ListObjectIdFilter
|
|
providerId - ObjectIdFilter
|
|
patientDotSpecies - StrFilter
|
|
patientDotBreed - StrFilter
|
|
createdAt - DateFilter
|
|
status - StrFilter
|
Example
{
"patientId": ListObjectIdFilter,
"providerId": ObjectIdFilter,
"patientDotSpecies": StrFilter,
"patientDotBreed": StrFilter,
"createdAt": DateFilter,
"status": StrFilter
}
VisitNoteViewSchema
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
vet - ClinicUserSchema
|
|
tech - ClinicUserSchema
|
|
patientId - ID
|
|
status - SoapStatusEnum!
|
|
patient - PatientSchema!
|
|
createdAt - datetime!
|
|
appointment - AppointmentSchema
|
|
appointmentType - AppointmentTypeResolveSchema
|
Example
{
"id": "4",
"vet": ClinicUserSchema,
"tech": ClinicUserSchema,
"patientId": "4",
"status": "DRAFT",
"patient": PatientSchema,
"createdAt": datetime,
"appointment": AppointmentSchema,
"appointmentType": AppointmentTypeResolveSchema
}
VisitNoteViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [VisitNoteViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [VisitNoteViewSchemaEdge]
}
VisitNoteViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - VisitNoteViewSchema!
|
|
cursor - String!
|
Example
{
"node": VisitNoteViewSchema,
"cursor": "abc123"
}
VisitSummarySchema
Fields
| Field Name | Description |
|---|---|
soapIncludes - [VisitSummarySoapSection!]
|
|
surgeryIncludes - [VisitSummarySurgerySection!]
|
|
visitIncludes - [VisitSummaryVisitSection!]
|
Example
{
"soapIncludes": ["PATIENT_VITALS"],
"surgeryIncludes": ["PATIENT_VITALS"],
"visitIncludes": ["PATIENT_VITALS"]
}
VisitSummarySoapSection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PATIENT_VITALS"
VisitSummarySurgerySection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PATIENT_VITALS"
VisitSummaryUpdateSchema
Fields
| Input Field | Description |
|---|---|
soapIncludes - [VisitSummarySoapSection!]
|
|
surgeryIncludes - [VisitSummarySurgerySection!]
|
|
visitIncludes - [VisitSummaryVisitSection!]
|
Example
{
"soapIncludes": ["PATIENT_VITALS"],
"surgeryIncludes": ["PATIENT_VITALS"],
"visitIncludes": ["PATIENT_VITALS"]
}
VisitSummaryVisitSection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PATIENT_VITALS"
VoiceNoteCreateSchema
Fields
| Input Field | Description |
|---|---|
patientId - ID
|
|
convertedSoapNote - String
|
|
recordings - [RecordingUpdateSchema!]!
|
Example
{
"patientId": "4",
"convertedSoapNote": "abc123",
"recordings": [RecordingUpdateSchema]
}
VoiceNoteSchema
Example
{
"creatorId": "4",
"id": 4,
"soapId": 4,
"patientId": 4,
"convertedSoapNote": "xyz789",
"recordings": [RecordingSchema],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
VoiceNoteViewFilterSchema
Fields
| Input Field | Description |
|---|---|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"createdAt": DateFilter,
"deletedAt": StrFilter
}
VoiceNoteViewSchema
Fields
| Field Name | Description |
|---|---|
soapId - ID
|
|
patientId - ID
|
|
convertedSoapNote - String
|
|
id - String!
|
|
patient - PatientSchema
|
|
soap - SoapSchema
|
|
recordings - [RecordingSchema!]!
|
|
deletedAt - datetime
|
|
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"soapId": "4",
"patientId": 4,
"convertedSoapNote": "abc123",
"id": "abc123",
"patient": PatientSchema,
"soap": SoapSchema,
"recordings": [RecordingSchema],
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
VoiceNoteViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [VoiceNoteViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [VoiceNoteViewSchemaEdge]
}
VoiceNoteViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - VoiceNoteViewSchema!
|
|
cursor - String!
|
Example
{
"node": VoiceNoteViewSchema,
"cursor": "abc123"
}
VoiceTokenSchema
Fields
| Field Name | Description |
|---|---|
token - String!
|
Example
{"token": "abc123"}
Void
Description
Represents NULL values
VoipOptionsSchema
VoipOptionsUpdateSchema
WeightUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"KG"
WorkflowActionInputSchema
Fields
| Input Field | Description |
|---|---|
type - ActionType!
|
|
timing - ActionTimingInput!
|
|
config - WorkflowAutomationActionConfigInput!
|
Example
{
"type": "SEND_EMAIL",
"timing": ActionTimingInput,
"config": WorkflowAutomationActionConfigInput
}
WorkflowAutomation
Fields
| Field Name | Description |
|---|---|
pendingExecutionsCount - Int!
|
|
id - ID!
|
MongoDB document ObjectID |
name - String!
|
Human-readable name for the workflow |
description - String
|
Detailed description of what this workflow does |
status - WorkflowStatus!
|
Current status of the workflow |
createdBy - ID
|
User who created the workflow |
clinicId - ID
|
Clinic this workflow belongs to |
triggers - [WorkflowAutomationTrigger!]!
|
List of triggers that can start this workflow |
triggerLogic - ConditionLogic!
|
Logic for combining triggers |
actions - [WorkflowAutomationAction!]!
|
List of actions to execute |
instanceId - ID!
|
Unique instance identifier for this version of the workflow |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
updatedBy - ID
|
User who last updated the workflow |
Example
{
"pendingExecutionsCount": 987,
"id": "4",
"name": "abc123",
"description": "abc123",
"status": "ACTIVE",
"createdBy": "4",
"clinicId": "4",
"triggers": [WorkflowAutomationTrigger],
"triggerLogic": "AND",
"actions": [WorkflowAutomationAction],
"instanceId": "4",
"createdAt": datetime,
"updatedAt": datetime,
"updatedBy": "4"
}
WorkflowAutomationAction
Fields
| Field Name | Description |
|---|---|
type - ActionType!
|
|
timing - ActionTiming!
|
|
config - WorkflowAutomationActionConfig!
|
Example
{
"type": "SEND_EMAIL",
"timing": ActionTiming,
"config": WorkflowAutomationActionConfig
}
WorkflowAutomationActionConfig
WorkflowAutomationActionConfigInput
WorkflowAutomationActionOption
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
methods - [String!]!
|
|
timingOptions - [String!]!
|
|
timingConfig - WorkflowAutomationTimingConfig!
|
|
requiresTemplate - Boolean!
|
Example
{
"name": "xyz789",
"methods": ["abc123"],
"timingOptions": ["xyz789"],
"timingConfig": WorkflowAutomationTimingConfig,
"requiresTemplate": false
}
WorkflowAutomationConditions
Fields
| Field Name | Description |
|---|---|
fieldConditions - [FieldCondition!]!
|
|
conditionLogic - ConditionLogic!
|
Example
{
"fieldConditions": [FieldCondition],
"conditionLogic": "AND"
}
WorkflowAutomationConditionsInput
Fields
| Input Field | Description |
|---|---|
fieldConditions - [FieldConditionInput!]!
|
|
conditionLogic - ConditionLogic!
|
Example
{
"fieldConditions": [FieldConditionInput],
"conditionLogic": "AND"
}
WorkflowAutomationCreateInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
description - String
|
|
clinicId - String!
|
|
status - WorkflowStatus!
|
|
triggers - [TriggerInputSchema!]!
|
|
triggerLogic - ConditionLogic!
|
|
actions - [WorkflowActionInputSchema!]!
|
|
createdBy - ID
|
Example
{
"name": "xyz789",
"description": "abc123",
"clinicId": "abc123",
"status": "ACTIVE",
"triggers": [TriggerInputSchema],
"triggerLogic": "AND",
"actions": [WorkflowActionInputSchema],
"createdBy": "4"
}
WorkflowAutomationFieldOption
Fields
| Field Name | Description |
|---|---|
field - String!
|
|
options - [WorkflowAutomationFieldOptionValue!]!
|
Example
{
"field": "xyz789",
"options": [WorkflowAutomationFieldOptionValue]
}
WorkflowAutomationFieldOptionValue
WorkflowAutomationOptions
Fields
| Field Name | Description |
|---|---|
triggers - [WorkflowAutomationTriggerOption!]!
|
|
actions - [WorkflowAutomationActionOption!]!
|
|
operators - [String!]!
|
Example
{
"triggers": [WorkflowAutomationTriggerOption],
"actions": [WorkflowAutomationActionOption],
"operators": ["xyz789"]
}
WorkflowAutomationTimingConfig
Fields
| Field Name | Description |
|---|---|
units - [String!]!
|
|
whenOptions - [String!]!
|
Example
{
"units": ["abc123"],
"whenOptions": ["abc123"]
}
WorkflowAutomationTrigger
Fields
| Field Name | Description |
|---|---|
type - TriggerType!
|
|
operator - ConditionOperator!
|
|
conditions - WorkflowAutomationConditions!
|
Example
{
"type": "APPOINTMENT_CREATED",
"operator": "EQUALS",
"conditions": WorkflowAutomationConditions
}
WorkflowAutomationTriggerOption
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
operators - [String!]!
|
|
fieldOptions - [WorkflowAutomationFieldOption!]!
|
|
eventType - String!
|
Example
{
"id": "4",
"name": "xyz789",
"operators": ["abc123"],
"fieldOptions": [WorkflowAutomationFieldOption],
"eventType": "abc123"
}
WorkflowAutomationUpdateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
description - String
|
|
clinicId - String
|
|
status - WorkflowStatus
|
|
triggers - [TriggerInputSchema!]
|
|
triggerLogic - ConditionLogic
|
|
actions - [WorkflowActionInputSchema!]
|
|
updatedBy - ID
|
|
updatePendingExecutions - Boolean
|
Example
{
"id": 4,
"name": "xyz789",
"description": "xyz789",
"clinicId": "xyz789",
"status": "ACTIVE",
"triggers": [TriggerInputSchema],
"triggerLogic": "AND",
"actions": [WorkflowActionInputSchema],
"updatedBy": 4,
"updatePendingExecutions": true
}
WorkflowAutomationView
Fields
| Field Name | Description |
|---|---|
pendingExecutionsCount - Int!
|
|
workflowId - ID!
|
|
name - String!
|
Human-readable name for the workflow |
description - String
|
Detailed description of what this workflow does |
status - WorkflowStatus!
|
Current status of the workflow |
createdBy - ID
|
User who created the workflow |
clinicId - ID
|
Clinic this workflow belongs to |
triggers - [WorkflowAutomationTrigger!]!
|
List of triggers that can start this workflow |
triggerLogic - ConditionLogic!
|
Logic for combining triggers |
actions - [WorkflowAutomationAction!]!
|
List of actions to execute |
instanceId - ID!
|
Unique instance identifier for this version of the workflow |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
updatedBy - ID
|
User who last updated the workflow |
Example
{
"pendingExecutionsCount": 987,
"workflowId": 4,
"name": "xyz789",
"description": "xyz789",
"status": "ACTIVE",
"createdBy": 4,
"clinicId": 4,
"triggers": [WorkflowAutomationTrigger],
"triggerLogic": "AND",
"actions": [WorkflowAutomationAction],
"instanceId": 4,
"createdAt": datetime,
"updatedAt": datetime,
"updatedBy": "4"
}
WorkflowAutomationViewConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [WorkflowAutomationViewEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [WorkflowAutomationViewEdge]
}
WorkflowAutomationViewEdge
Fields
| Field Name | Description |
|---|---|
node - WorkflowAutomationView!
|
|
cursor - String!
|
Example
{
"node": WorkflowAutomationView,
"cursor": "abc123"
}
WorkflowAutomationViewFilterSchema
WorkflowStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
XrayCreateSchema
XrayModalitySchema
XraySchema
Fields
| Field Name | Description |
|---|---|
resultUrl - String
|
|
treatment - TreatmentSchema!
|
|
surgery - SurgerySchema!
|
|
soap - SoapSchema!
|
|
visitNote - VisitNoteSchema!
|
|
orderNote - OrderNoteSchema!
|
|
patient - PatientSchema!
|
|
provider - ClinicUserSchema!
|
|
id - ID!
|
MongoDB document ObjectID |
treatmentId - ID!
|
Reference to the associated treatment (Treatment model) |
patientId - ID!
|
Reference to the patient receiving the x-ray (ClinicPatient model) |
soapId - ID
|
Reference to associated SOAP note (Soap model) |
surgeryId - ID
|
Reference to associated surgery record (Surgery model) |
visitNoteId - ID
|
Reference to associated visit note (VisitNote model) |
orderNoteId - ID
|
Reference to associated order note (OrderNote model) |
isStaff - Boolean!
|
Whether this x-ray was ordered by staff vs client request |
providerId - ID!
|
Reference to the veterinarian ordering the x-ray (ClinicUser model) |
status - XrayStatus!
|
Current status of the x-ray order (new, submitted, complete, cancelled, failed) |
notes - String
|
Additional notes or instructions for the x-ray |
deletedAt - datetime
|
Soft deletion timestamp - when set, x-ray is considered deleted |
createdAt - datetime!
|
|
updatedAt - datetime!
|
Example
{
"resultUrl": "xyz789",
"treatment": TreatmentSchema,
"surgery": SurgerySchema,
"soap": SoapSchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema,
"patient": PatientSchema,
"provider": ClinicUserSchema,
"id": 4,
"treatmentId": 4,
"patientId": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"orderNoteId": "4",
"isStaff": false,
"providerId": 4,
"status": "NEW",
"notes": "xyz789",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime
}
XrayStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NEW"
XrayUpdateSchema
XrayVendor
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OTHER"
XrayViewFilterSchema
Fields
| Input Field | Description |
|---|---|
treatmentId - ObjectIdFilter
|
|
patientId - ObjectIdFilter
|
|
soapId - ObjectIdFilter
|
|
surgeryId - ObjectIdFilter
|
|
visitNoteId - ObjectIdFilter
|
|
orderNoteId - ObjectIdFilter
|
|
providerId - ObjectIdFilter
|
|
status - StrListFilter
|
|
createdAt - DateFilter
|
|
deletedAt - StrFilter
|
Example
{
"treatmentId": ObjectIdFilter,
"patientId": ObjectIdFilter,
"soapId": ObjectIdFilter,
"surgeryId": ObjectIdFilter,
"visitNoteId": ObjectIdFilter,
"orderNoteId": ObjectIdFilter,
"providerId": ObjectIdFilter,
"status": StrListFilter,
"createdAt": DateFilter,
"deletedAt": StrFilter
}
XrayViewSchema
Fields
| Field Name | Description |
|---|---|
treatmentId - ID!
|
Reference to the associated treatment (Treatment model) |
patientId - ID!
|
Reference to the patient receiving the x-ray (ClinicPatient model) |
soapId - ID
|
Reference to associated SOAP note (Soap model) |
surgeryId - ID
|
Reference to associated surgery record (Surgery model) |
visitNoteId - ID
|
Reference to associated visit note (VisitNote model) |
isStaff - Boolean!
|
Whether this x-ray was ordered by staff vs client request |
providerId - ID!
|
Reference to the veterinarian ordering the x-ray (ClinicUser model) |
status - XrayStatus!
|
Current status of the x-ray order (new, submitted, complete, cancelled, failed) |
notes - String
|
Additional notes or instructions for the x-ray |
deletedAt - datetime
|
Soft deletion timestamp - when set, x-ray is considered deleted |
createdAt - datetime!
|
|
updatedAt - datetime!
|
|
id - ID!
|
|
patient - PatientSchema!
|
|
treatment - TreatmentSchema!
|
|
provider - ClinicUserSchema!
|
|
soap - SoapSchema
|
|
surgery - SurgerySchema
|
|
visitNote - VisitNoteSchema
|
|
orderNote - OrderNoteSchema
|
Example
{
"treatmentId": 4,
"patientId": 4,
"soapId": 4,
"surgeryId": "4",
"visitNoteId": "4",
"isStaff": true,
"providerId": "4",
"status": "NEW",
"notes": "abc123",
"deletedAt": datetime,
"createdAt": datetime,
"updatedAt": datetime,
"id": 4,
"patient": PatientSchema,
"treatment": TreatmentSchema,
"provider": ClinicUserSchema,
"soap": SoapSchema,
"surgery": SurgerySchema,
"visitNote": VisitNoteSchema,
"orderNote": OrderNoteSchema
}
XrayViewSchemaConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [XrayViewSchemaEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [XrayViewSchemaEdge]
}
XrayViewSchemaEdge
Fields
| Field Name | Description |
|---|---|
node - XrayViewSchema!
|
|
cursor - String!
|
Example
{
"node": XrayViewSchema,
"cursor": "xyz789"
}
datetime
Example
datetime