mutation( $encounterId: ID!, $sectionIdx: Int!, $sessionId: String) { acquireEncounterSectionLock( encounterId: $encounterId, sectionIdx: $sectionIdx, sessionId: $sessionId ) { id # Add other fields you need }}{ "encounterId": "1", "sectionIdx": 1, "sessionId": "example"}mutation( $medicationId: ID!, $sessionId: String!) { acquirePharmacyMedicationLock( medicationId: $medicationId, sessionId: $sessionId ) { id # Add other fields you need }}{ "medicationId": "1", "sessionId": "example"}| Argument | Type | Description |
|---|---|---|
itemsrequired | [VisitItemInput!]! | Items |
visitIdrequired | ID! | ID of the visit |
mutation( $items: [VisitItemInput!]!, $visitId: ID!) { addItemsToVisit( items: $items, visitId: $visitId ) { id # Add other fields you need }}{ "items": {}, "visitId": "1"}mutation( $id: ID!, $notes: String, $preferred: Boolean, $rdvmId: ID!, $referringDoctors: String) { addPatientRdvm( id: $id, notes: $notes, preferred: $preferred, rdvmId: $rdvmId, referringDoctors: $referringDoctors ) { id # Add other fields you need }}{ "id": "1", "notes": "example", "preferred": true, "rdvmId": "1", "referringDoctors": "example"}| Argument | Type | Description |
|---|---|---|
inputrequired | TreatmentInput! | Input |
mutation($input: TreatmentInput!) { addTreatment(input: $input) { id # Add other fields you need }}{ "input": {}}Approve a medication and send it to the pharmacy whiteboard
| Argument | Type | Description |
|---|---|---|
inputrequired | MedicationInput! | Input |
medicationIdrequired | ID! | ID of the medication |
mutation( $input: MedicationInput!, $medicationId: ID!) { approveAndSendToPharmacy( input: $input, medicationId: $medicationId ) { id # Add other fields you need }}{ "input": {}, "medicationId": "1"}Approve a cubex-related diagnostic with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ApproveCubexDiagnosticInput! | Input |
mutation( $id: ID!, $input: ApproveCubexDiagnosticInput!) { approveCubexDiagnostic( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Approve a cubex-related encounter product with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ApproveCubexEncounterProductInput! | Input |
mutation( $id: ID!, $input: ApproveCubexEncounterProductInput!) { approveCubexEncounterProduct( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Approve a cubex-related immunization with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ApproveCubexImmunizationInput! | Input |
mutation( $id: ID!, $input: ApproveCubexImmunizationInput!) { approveCubexImmunization( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Approve a cubex-related medication with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ApproveCubexMedicationInput! | Input |
mutation( $id: ID!, $input: ApproveCubexMedicationInput!) { approveCubexMedication( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Approve a cubex-related treatment with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ApproveCubexTreatmentInput! | Input |
mutation( $id: ID!, $input: ApproveCubexTreatmentInput!) { approveCubexTreatment( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Approves a medication.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ApproveMedicationInput! | Input |
mutation( $id: ID!, $input: ApproveMedicationInput!) { approveMedication( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Atomically replaces multiple encounter section datums in a single transaction. All replacements are validated and executed atomically - if any datum doesn't exist, the entire operation rolls back.
| Argument | Type | Description |
|---|---|---|
encounterIdrequired | ID! | ID of the clinical encounter |
inputsrequired | [EncounterSectionDatumReplaceInput!]! | Inputs |
sessionId | String | ID of the session |
mutation( $encounterId: ID!, $inputs: [EncounterSectionDatumReplaceInput!]!, $sessionId: String) { batchReplaceEncounterSectionDatums( encounterId: $encounterId, inputs: $inputs, sessionId: $sessionId ) { id # Add other fields you need }}{ "encounterId": "1", "inputs": {}, "sessionId": "example"}| Argument | Type | Description |
|---|---|---|
encounterTypeIdrequired | ID! | ID of the encountertype |
overridesrequired | [EncounterTypeSectionOverrideItemInput!]! | Overrides |
mutation( $encounterTypeId: ID!, $overrides: [EncounterTypeSectionOverrideItemInput!]!) { bulkUpdateEncounterTypeSectionOverrides( encounterTypeId: $encounterTypeId, overrides: $overrides ) { id # Add other fields you need }}{ "encounterTypeId": "1", "overrides": {}}| Argument | Type | Description |
|---|---|---|
clientConsentId | ID | if existing consent already made |
clientId | ID | ID of the client (pet owner) |
consentrequired | String! | Consent agreement status |
consentFormId | ID | ID of the consent form |
encounterId | ID | ID of the clinical encounter |
estimateId | ID | ID of the estimate |
locationId | ID | ID of the location |
namerequired | String! | Name of the resource |
patientId | ID | ID of the patient |
signaturerequired | String! | Signature |
mutation( $clientConsentId: ID, $clientId: ID, $consent: String!, $consentFormId: ID, $encounterId: ID, $estimateId: ID, $locationId: ID, $name: String!, $patientId: ID, $signature: String!) { captureClientConsent( clientConsentId: $clientConsentId, clientId: $clientId, consent: $consent, consentFormId: $consentFormId, encounterId: $encounterId, estimateId: $estimateId, locationId: $locationId, name: $name, patientId: $patientId, signature: $signature ) { id # Add other fields you need }}{ "clientConsentId": "1", "clientId": "1", "consent": "example", "consentFormId": "1", "encounterId": "1", "estimateId": "1", "locationId": "1", "name": "example", "patientId": "1", "signature": "example"}| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
consent | String | Consent agreement status |
consentFormId | ID | ID of the consent form |
encounterId | ID | ID of the clinical encounter |
estimateId | ID | ID of the estimate |
locationId | ID | ID of the location |
name | String | Name of the resource |
patientId | ID | ID of the patient |
mutation( $clientId: ID, $consent: String, $consentFormId: ID, $encounterId: ID, $estimateId: ID, $locationId: ID, $name: String, $patientId: ID) { clientConsentLink( clientId: $clientId, consent: $consent, consentFormId: $consentFormId, encounterId: $encounterId, estimateId: $estimateId, locationId: $locationId, name: $name, patientId: $patientId ) { id # Add other fields you need }}{ "clientId": "1", "consent": "example", "consentFormId": "1", "encounterId": "1", "estimateId": "1", "locationId": "1", "name": "example", "patientId": "1"}mutation($patientId: ID!) { createAllergy(patientId: $patientId) { id # Add other fields you need }}{ "patientId": "1"}| Argument | Type | Description |
|---|---|---|
appointmentIdrequired | ID! | ID of the appointment |
mutation($appointmentId: ID!) { createApptVitals(appointmentId: $appointmentId) { id # Add other fields you need }}{ "appointmentId": "1"}| Argument | Type | Description |
|---|---|---|
input | ComplicationInput | Input data for complication operation |
mutation($input: ComplicationInput) { createComplication(input: $input) { id # Add other fields you need }}{ "input": {}}| Argument | Type | Description |
|---|---|---|
input | CustomPatientProtocolInput | Input data for custom patient protocol operation |
mutation($input: CustomPatientProtocolInput) { createCustomPatientProtocol(input: $input) { id # Add other fields you need }}{ "input": {}}Adds a field service visit address to a patient
| Argument | Type | Description |
|---|---|---|
inputrequired | FieldServiceAddressInput! | Input |
patientIdrequired | ID! | ID of the patient |
mutation( $input: FieldServiceAddressInput!, $patientId: ID!) { createFieldServiceAddress( input: $input, patientId: $patientId ) { id # Add other fields you need }}{ "input": {}, "patientId": "1"}Create an immunization
| Argument | Type | Description |
|---|---|---|
inputrequired | ImmunizationInput! | Input |
mutation($input: ImmunizationInput!) { createImmunization(input: $input) { id # Add other fields you need }}{ "input": {}}| Argument | Type | Description |
|---|---|---|
inputrequired | MacroInput! | Input |
mutation($input: MacroInput!) { createMacro(input: $input) { id # Add other fields you need }}{ "input": {}}mutation($id: ID!) { createParentProblem(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
clientIdrequired | ID! | ID of the client (pet owner) |
input | PatientInput | Attributes to create a patient with |
mutation( $clientId: ID!, $input: PatientInput) { createPatient( clientId: $clientId, input: $input ) { id # Add other fields you need }}{ "clientId": "1", "input": {}}Create a new patient diagnosis entry
| Argument | Type | Description |
|---|---|---|
input | PatientDiagnosisInput | Input data for patient diagnosis operation |
patientIdrequired | ID! | ID of the patient |
mutation( $input: PatientDiagnosisInput, $patientId: ID!) { createPatientDiagnosis( input: $input, patientId: $patientId ) { id # Add other fields you need }}{ "input": {}, "patientId": "1"}| Argument | Type | Description |
|---|---|---|
input | PatientTagInput | Input data for patient tag operation |
mutation($input: PatientTagInput) { createPatientTag(input: $input) { id # Add other fields you need }}{ "input": {}}Create a new problem
| Argument | Type | Description |
|---|---|---|
input | ProblemInput | Input data for problem operation |
patientIdrequired | ID! | ID of the patient |
mutation( $input: ProblemInput, $patientId: ID!) { createProblem( input: $input, patientId: $patientId ) { id # Add other fields you need }}{ "input": {}, "patientId": "1"}| Argument | Type | Description |
|---|---|---|
input | VitalsInput | Input data for vitals operation |
mutation($input: VitalsInput) { createVitals(input: $input) { id # Add other fields you need }}{ "input": {}}Decline a cubex-related diagnostic with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { declineCubexDiagnostic(id: $id) { id # Add other fields you need }}{ "id": "1"}Decline a cubex-related encounter product with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { declineCubexEncounterProduct(id: $id) { id # Add other fields you need }}{ "id": "1"}Decline a cubex-related immunization with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { declineCubexImmunization(id: $id) { id # Add other fields you need }}{ "id": "1"}Decline a cubex-related medication with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { declineCubexMedication(id: $id) { id # Add other fields you need }}{ "id": "1"}Decline a cubex-related treatment with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { declineCubexTreatment(id: $id) { id # Add other fields you need }}{ "id": "1"}mutation($id: ID!) { deleteAllergy(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deleteClientConsent(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deleteComplication(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
encounterTypeIdrequired | ID! | ID of the encountertype |
mutation($encounterTypeId: ID!) { deleteEncounterTypeSectionOverrides(encounterTypeId: $encounterTypeId) { id # Add other fields you need }}{ "encounterTypeId": "1"}Deletes one of a patient's field service visit addresses, returning the deleted address. Appointments already booked against the address keep their booking and lose their visit location, so deleting an address referenced by future appointments is safe.
mutation( $id: ID!, $newDefaultId: ID) { deleteFieldServiceAddress( id: $id, newDefaultId: $newDefaultId ) { id # Add other fields you need }}{ "id": "1", "newDefaultId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deleteImmunization(id: $id) { id # Add other fields you need }}{ "id": "1"}mutation($id: ID!) { deleteMacro(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deleteMedication(id: $id) { id # Add other fields you need }}{ "id": "1"}Delete a patient diagnosis entry
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deletePatientDiagnosis(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deletePatientDocument(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { deletePatientTag(id: $id) { id # Add other fields you need }}{ "id": "1"}mutation($id: ID!) { deleteProblem(id: $id) { id # Add other fields you need }}{ "id": "1"}mutation($id: ID!) { deleteVitals(id: $id) { id # Add other fields you need }}{ "id": "1"}mutation( $id: ID!, $notes: String, $preferred: Boolean, $rdvmId: ID!, $referringDoctors: String) { editPatientRdvm( id: $id, notes: $notes, preferred: $preferred, rdvmId: $rdvmId, referringDoctors: $referringDoctors ) { id # Add other fields you need }}{ "id": "1", "notes": "example", "preferred": true, "rdvmId": "1", "referringDoctors": "example"}| Argument | Type | Description |
|---|---|---|
encounterIdrequired | ID! | ID of the clinical encounter |
type | EncounterPdfType | Type or classification |
mutation( $encounterId: ID!, $type: EncounterPdfType) { emailEncounterPdf( encounterId: $encounterId, type: $type ) { id # Add other fields you need }}{ "encounterId": "1", "type": {}}mutation( $encounterId: ID!, $patientId: ID!) { emailHospitalizationNoticeToRdvms( encounterId: $encounterId, patientId: $patientId ) { id # Add other fields you need }}{ "encounterId": "1", "patientId": "1"}mutation( $emails: [String!], $ids: [ID!], $isLatest: Boolean, $locationId: ID, $patientId: ID!) { emailImmunizationsRecord( emails: $emails, ids: $ids, isLatest: $isLatest, locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "emails": {}, "ids": {}, "isLatest": true, "locationId": "1", "patientId": "1"}mutation( $ignoreHistorical: Boolean, $locationId: ID, $patientId: ID!) { emailRabiesCertificate( ignoreHistorical: $ignoreHistorical, locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "ignoreHistorical": true, "locationId": "1", "patientId": "1"}mutation( $emails: [String!], $ids: [ID!], $locationId: ID, $patientId: ID!) { emailSelectedRabiesCertificates( emails: $emails, ids: $ids, locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "emails": {}, "ids": {}, "locationId": "1", "patientId": "1"}| Argument | Type | Description |
|---|---|---|
encounterIdrequired | ID! | ID of the clinical encounter |
type | EncounterPdfType | Type or classification |
mutation( $encounterId: ID!, $type: EncounterPdfType) { encounterPdf( encounterId: $encounterId, type: $type ) { id # Add other fields you need }}{ "encounterId": "1", "type": {}}| Argument | Type | Description |
|---|---|---|
stop | NaiveDateTime | Stop |
visitIdrequired | ID! | ID of the visit |
mutation( $stop: NaiveDateTime, $visitId: ID!) { endVisit( stop: $stop, visitId: $visitId ) { id # Add other fields you need }}{ "stop": {}, "visitId": "1"}mutation( $locationId: ID, $name: String!, $patientId: ID) { genVetsourceUrl( locationId: $locationId, name: $name, patientId: $patientId ) { id # Add other fields you need }}{ "locationId": "1", "name": "example", "patientId": "1"}Import an entity from a patient document. Exactly one of medication, immunization, or patient_protocol must be provided.
| Argument | Type | Description |
|---|---|---|
inputrequired | ImportFromDocumentInput! | Input |
mutation($input: ImportFromDocumentInput!) { importFromDocument(input: $input) { id # Add other fields you need }}{ "input": {}}mutation( $encounterId: ID!, $encounterTypeId: ID!, $sectionIdx: Int!) { insertNewTemplate( encounterId: $encounterId, encounterTypeId: $encounterTypeId, sectionIdx: $sectionIdx ) { id # Add other fields you need }}{ "encounterId": "1", "encounterTypeId": "1", "sectionIdx": 1}Mark a cubex-related diagnostic as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { markCubexDiagnosticAsPendingApproval(id: $id) { id # Add other fields you need }}{ "id": "1"}Mark a cubex-related encounter product as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { markCubexEncounterProductAsPendingApproval(id: $id) { id # Add other fields you need }}{ "id": "1"}Mark a cubex-related immunization as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { markCubexImmunizationAsPendingApproval(id: $id) { id # Add other fields you need }}{ "id": "1"}Mark a cubex-related medication as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { markCubexMedicationAsPendingApproval(id: $id) { id # Add other fields you need }}{ "id": "1"}Mark a cubex-related treatment as pending approval. Should only be used when the Cubex Two-Way integration is enabled.
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
mutation($id: ID!) { markCubexTreatmentAsPendingApproval(id: $id) { id # Add other fields you need }}{ "id": "1"}mutation( $readyForDischarge: Boolean, $visitId: ID!) { markVisitReadyForDischarge( readyForDischarge: $readyForDischarge, visitId: $visitId ) { id # Add other fields you need }}{ "readyForDischarge": true, "visitId": "1"}| Argument | Type | Description |
|---|---|---|
patientRegistrations | [PatientRegistration] | Patient registrations |
mutation($patientRegistrations: [PatientRegistration]) { massMicrochipRegister(patientRegistrations: $patientRegistrations) { id # Add other fields you need }}{ "patientRegistrations": {}}mutation( $fromPatientId: ID!, $toPatientId: ID!) { mergePatients( fromPatientId: $fromPatientId, toPatientId: $toPatientId ) { id # Add other fields you need }}{ "fromPatientId": "1", "toPatientId": "1"}mutation( $clientId: ID!, $patientId: ID!) { movePatientToClient( clientId: $clientId, patientId: $patientId ) { id # Add other fields you need }}{ "clientId": "1", "patientId": "1"}Prescribe a medication
| Argument | Type | Description |
|---|---|---|
inputrequired | MedicationInput! | Input |
mutation($input: MedicationInput!) { prescribeMedication(input: $input) { id # Add other fields you need }}{ "input": {}}| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
diagnosticId | ID | ID of the diagnostic |
input | PrinterInput | Input data for printer operation |
medicationId | ID | ID of the medication |
patientId | ID | ID of the patient |
mutation( $clientId: ID, $diagnosticId: ID, $input: PrinterInput, $medicationId: ID, $patientId: ID) { printLabelPrintnode( clientId: $clientId, diagnosticId: $diagnosticId, input: $input, medicationId: $medicationId, patientId: $patientId ) { id # Add other fields you need }}{ "clientId": "1", "diagnosticId": "1", "input": {}, "medicationId": "1", "patientId": "1"}| Argument | Type | Description |
|---|---|---|
datetime | NaiveDateTime | Specific date and time |
patientIdrequired | ID! | ID of the patient |
weightrequired | Decimal! | Weight |
weightUnitrequired | WeightUnit! | Weight unit |
mutation( $datetime: NaiveDateTime, $patientId: ID!, $weight: Decimal!, $weightUnit: WeightUnit!) { recordPatientWeight( datetime: $datetime, patientId: $patientId, weight: $weight, weightUnit: $weightUnit ) { id # Add other fields you need }}{ "datetime": {}, "patientId": "1", "weight": {}, "weightUnit": {}}mutation( $id: ID!, $locationId: ID, $lotNumber: String, $prescriberId: ID, $start: Date, $stop: Date) { refillAndSendToPharmacy( id: $id, locationId: $locationId, lotNumber: $lotNumber, prescriberId: $prescriberId, start: $start, stop: $stop ) { id # Add other fields you need }}{ "id": "1", "locationId": "1", "lotNumber": "example", "prescriberId": "1", "start": {}, "stop": {}}mutation( $id: ID!, $locationId: ID, $lotNumber: String, $prescriberId: ID, $start: Date, $stop: Date) { refillMedication( id: $id, locationId: $locationId, lotNumber: $lotNumber, prescriberId: $prescriberId, start: $start, stop: $stop ) { id # Add other fields you need }}{ "id": "1", "locationId": "1", "lotNumber": "example", "prescriberId": "1", "start": {}, "stop": {}}mutation( $locationId: ID!, $patientId: ID!) { registerPatientMicrochip( locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "locationId": "1", "patientId": "1"}| Argument | Type | Description |
|---|---|---|
itemsrequired | [VisitItemInput!]! | Items |
visitIdrequired | ID! | ID of the visit |
mutation( $items: [VisitItemInput!]!, $visitId: ID!) { removeItemsFromVisit( items: $items, visitId: $visitId ) { id # Add other fields you need }}{ "items": {}, "visitId": "1"}mutation( $id: ID!, $rdvmId: ID!) { removePatientRdvm( id: $id, rdvmId: $rdvmId ) { id # Add other fields you need }}{ "id": "1", "rdvmId": "1"}mutation($visitId: ID!) { reopenVisit(visitId: $visitId) { id # Add other fields you need }}{ "visitId": "1"}Update a draft medication to request approval from a veterinarian
| Argument | Type | Description |
|---|---|---|
inputrequired | MedicationInput! | Input |
medicationIdrequired | ID! | ID of the medication |
mutation( $input: MedicationInput!, $medicationId: ID!) { requestMedicationApproval( input: $input, medicationId: $medicationId ) { id # Add other fields you need }}{ "input": {}, "medicationId": "1"}mutation($patientId: ID!) { saveMicrochip(patientId: $patientId) { id # Add other fields you need }}{ "patientId": "1"}Create or update the current org's AI PDF extraction rule. Only the given fields change, so saving a test run leaves the rule's active flag alone.
| Argument | Type | Description |
|---|---|---|
inputrequired | PdfExtractionRuleInput! | Input |
mutation($input: PdfExtractionRuleInput!) { savePdfExtractionRule(input: $input) { id # Add other fields you need }}{ "input": {}}| Argument | Type | Description |
|---|---|---|
consentrequired | String! | Consent agreement status |
estimateIdrequired | ID! | ID of the estimate |
mediumrequired | ConversationMedium! | Medium |
mutation( $consent: String!, $estimateId: ID!, $medium: ConversationMedium!) { sendEstimateConsentDepositLink( consent: $consent, estimateId: $estimateId, medium: $medium ) { id # Add other fields you need }}{ "consent": "example", "estimateId": "1", "medium": {}}| Argument | Type | Description |
|---|---|---|
encounterIdrequired | ID! | ID of the clinical encounter |
mutation($encounterId: ID!) { sendSurveyLink(encounterId: $encounterId) { id # Add other fields you need }}{ "encounterId": "1"}Start a test extraction using the given per-type instructions. Upload a PDF, or omit it to re-run against the one already stored on the org's rule.
mutation( $file: Upload, $immunizationInstructions: String, $medicationInstructions: String, $patientInstructions: String, $reminderInstructions: String) { startPdfExtractionTestRun( file: $file, immunizationInstructions: $immunizationInstructions, medicationInstructions: $medicationInstructions, patientInstructions: $patientInstructions, reminderInstructions: $reminderInstructions ) { id # Add other fields you need }}{ "file": {}, "immunizationInstructions": "example", "medicationInstructions": "example", "patientInstructions": "example", "reminderInstructions": "example"}mutation( $locationId: ID!, $patientId: ID!) { startVisit( locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "locationId": "1", "patientId": "1"}mutation($locationId: ID!) { surgeryLogPdf(locationId: $locationId) { id # Add other fields you need }}{ "locationId": "1"}| Argument | Type | Description |
|---|---|---|
encounterTypeIdrequired | ID! | ID of the encountertype |
encounterTypeName | String | Encounter type name |
locationId | ID | ID of the location |
patientId | String | ID of the patient |
referenceRecordingId | String | ID of the referencerecording |
sectionsrequired | [JSON!]! | Sections |
sourcerequired | String! | Source |
transcript | String | Transcript |
mutation( $encounterTypeId: ID!, $encounterTypeName: String, $locationId: ID, $patientId: String, $referenceRecordingId: String, $sections: [JSON!]!, $source: String!, $transcript: String) { testScribeInstructions( encounterTypeId: $encounterTypeId, encounterTypeName: $encounterTypeName, locationId: $locationId, patientId: $patientId, referenceRecordingId: $referenceRecordingId, sections: $sections, source: $source, transcript: $transcript ) { id # Add other fields you need }}{ "encounterTypeId": "1", "encounterTypeName": "example", "locationId": "1", "patientId": "example", "referenceRecordingId": "example", "sections": {}, "source": "example", "transcript": "example"}Toggle the completed by status of an encounter section
mutation( $encounterId: ID!, $sectionIdx: Int!) { toggleEncounterSectionCompletedBy( encounterId: $encounterId, sectionIdx: $sectionIdx ) { id # Add other fields you need }}{ "encounterId": "1", "sectionIdx": 1}mutation( $patientId: ID!, $toClientId: ID!) { transferPatient( patientId: $patientId, toClientId: $toClientId ) { id # Add other fields you need }}{ "patientId": "1", "toClientId": "1"}| Argument | Type | Description |
|---|---|---|
medicationIdrequired | ID! | ID of the medication |
mutation($medicationId: ID!) { triggerPrescription(medicationId: $medicationId) { id # Add other fields you need }}{ "medicationId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | AllergyInput! | Input |
mutation( $id: ID!, $input: AllergyInput!) { updateAllergy( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ComplicationInput! | Input |
mutation( $id: ID!, $input: ComplicationInput!) { updateComplication( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
input | CustomPatientProtocolInput | Input data for custom patient protocol operation |
mutation( $id: ID!, $input: CustomPatientProtocolInput) { updateCustomPatientProtocol( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Updates one of a patient's field service visit addresses
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | FieldServiceAddressInput! | Input |
mutation( $id: ID!, $input: FieldServiceAddressInput!) { updateFieldServiceAddress( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ImmunizationInput! | Input |
mutation( $id: ID!, $input: ImmunizationInput!) { updateImmunization( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Update a linked clinical note
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
input | LinkedClinicalNoteInput | Input data for linked clinical note operation |
mutation( $id: ID!, $input: LinkedClinicalNoteInput) { updateLinkedClinicalNote( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | MacroInput! | Input |
mutation( $id: ID!, $input: MacroInput!) { updateMacro( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Update a medication
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | MedicationInput! | Input |
mutation( $id: ID!, $input: MedicationInput!) { updateMedication( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Update pharmacy-specific fields in a medication
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | MedicationPharmacyFieldsInput! | Input |
mutation( $id: ID!, $input: MedicationPharmacyFieldsInput!) { updateMedicationPharmacyFields( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Update a medication with pharmacy status support
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | MedicationPharmacyStatusInput! | Input |
mutation( $id: ID!, $input: MedicationPharmacyStatusInput!) { updateMedicationWithPharmacyStatus( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | PatientInput! | Input |
mutation( $id: ID!, $input: PatientInput!) { updatePatient( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}Update an existing patient diagnosis entry
| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
input | PatientDiagnosisInput | Input data for patient diagnosis operation |
mutation( $id: ID!, $input: PatientDiagnosisInput) { updatePatientDiagnosis( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | PatientDocumentInput! | Input |
mutation( $id: ID!, $input: PatientDocumentInput!) { updatePatientDocument( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | PatientTagInput! | Input |
mutation( $id: ID!, $input: PatientTagInput!) { updatePatientTag( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
inputrequired | ProblemInput! | Input |
mutation( $id: ID!, $input: ProblemInput!) { updateProblem( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}mutation( $diagnosisIds: [ID], $rdvmIds: [ID], $showDiagnosis: Boolean, $showPrimaryContact: Boolean, $showRdvm: Boolean, $visitId: ID!) { updateVisitHeaderConfig( diagnosisIds: $diagnosisIds, rdvmIds: $rdvmIds, showDiagnosis: $showDiagnosis, showPrimaryContact: $showPrimaryContact, showRdvm: $showRdvm, visitId: $visitId ) { id # Add other fields you need }}{ "diagnosisIds": "1", "rdvmIds": "1", "showDiagnosis": true, "showPrimaryContact": true, "showRdvm": true, "visitId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
input | VitalsInput | Input data for vitals operation |
mutation( $id: ID!, $input: VitalsInput) { updateVitals( id: $id, input: $input ) { id # Add other fields you need }}{ "id": "1", "input": {}}mutation( $document: Upload!, $patientId: ID!) { uploadPatientImage( document: $document, patientId: $patientId ) { id # Add other fields you need }}{ "document": {}, "patientId": "1"}| Argument | Type | Description |
|---|---|---|
inputrequired | PatientContactDetailsInput! | Input |
patientIdrequired | ID! | ID of the patient |
mutation( $input: PatientContactDetailsInput!, $patientId: ID!) { upsertPatientContactDetails( input: $input, patientId: $patientId ) { id # Add other fields you need }}{ "input": {}, "patientId": "1"}mutation( $action: String!, $locationId: ID, $pin: String!, $providerId: ID) { validateControlledDrugPin( action: $action, locationId: $locationId, pin: $pin, providerId: $providerId ) { id # Add other fields you need }}{ "action": "example", "locationId": "1", "pin": "example", "providerId": "1"}mutation( $encounterId: ID!, $sectionName: String!) { valuesetLabel( encounterId: $encounterId, sectionName: $sectionName ) { id # Add other fields you need }}{ "encounterId": "1", "sectionName": "example"}