query($patientId: ID!) { allergies(patientId: $patientId) { id # Add other fields you need }}{ "patientId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { complication(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { complications( updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "updatedAtEnd": {}, "updatedAtStart": {}}query { dashboard { id # Add other fields you need }}| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
patientId | ID | ID of the patient |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $clientId: ID, $patientId: ID, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { diagnostics( clientId: $clientId, patientId: $patientId, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "clientId": "1", "patientId": "1", "updatedAtEnd": {}, "updatedAtStart": {}}query($id: ID!) { encounter(id: $id) { id # Add other fields you need }}{ "id": "1"}Get encounter care team members
| Argument | Type | Description |
|---|---|---|
encounterIdrequired | ID! | ID of the clinical encounter |
query($encounterId: ID!) { encounterCareTeamMembers(encounterId: $encounterId) { id # Add other fields you need }}{ "encounterId": "1"}| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
limit | Int | Maximum number of results to return |
locationId | ID | ID of the location |
offset | Int | Number of results to skip for pagination |
patientId | ID | ID of the patient |
providerId | ID | ID of the provider |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $clientId: ID, $limit: Int, $locationId: ID, $offset: Int, $patientId: ID, $providerId: ID, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { encounterProducts( clientId: $clientId, limit: $limit, locationId: $locationId, offset: $offset, patientId: $patientId, providerId: $providerId, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "clientId": "1", "limit": 1, "locationId": "1", "offset": 1, "patientId": "1", "providerId": "1", "updatedAtEnd": {}, "updatedAtStart": {}}query( $attachmentIds: [ID], $documentType: EncounterSummaryDocumentType, $encounterId: ID!, $extras: [String], $locationId: ID, $only: [String], $onlySections: [String]) { encounterSummary( attachmentIds: $attachmentIds, documentType: $documentType, encounterId: $encounterId, extras: $extras, locationId: $locationId, only: $only, onlySections: $onlySections ) { id # Add other fields you need }}{ "attachmentIds": "1", "documentType": {}, "encounterId": "1", "extras": "example", "locationId": "1", "only": "example", "onlySections": "example"}query( $isEmbeddable: Boolean, $locationId: ID, $onlyEnabled: Boolean) { encounterTypes( isEmbeddable: $isEmbeddable, locationId: $locationId, onlyEnabled: $onlyEnabled ) { id # Add other fields you need }}{ "isEmbeddable": true, "locationId": "1", "onlyEnabled": true}Search for encounters by patient id, org id, and status
| Argument | Type | Description |
|---|---|---|
additionalProviderOnly | Boolean | Additional provider only |
clientId | ID | ID of the client (pet owner) |
historicalId | String | ID of the historical |
limit | Int | Maximum number of results to return |
locationId | ID | ID of the location |
offset | Int | Number of results to skip for pagination |
patientId | ID | ID of the patient |
providerId | ID | ID of the provider |
signed | Boolean | Signed |
startAfter | NaiveDateTime | Start after |
startBefore | NaiveDateTime | Start before |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
viewerOnly | Boolean | Viewer only |
query( $additionalProviderOnly: Boolean, $clientId: ID, $historicalId: String, $limit: Int, $locationId: ID, $offset: Int, $patientId: ID, $providerId: ID, $signed: Boolean, $startAfter: NaiveDateTime, $startBefore: NaiveDateTime, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime, $viewerOnly: Boolean) { encounters( additionalProviderOnly: $additionalProviderOnly, clientId: $clientId, historicalId: $historicalId, limit: $limit, locationId: $locationId, offset: $offset, patientId: $patientId, providerId: $providerId, signed: $signed, startAfter: $startAfter, startBefore: $startBefore, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart, viewerOnly: $viewerOnly ) { id # Add other fields you need }}{ "additionalProviderOnly": true, "clientId": "1", "historicalId": "example", "limit": 1, "locationId": "1", "offset": 1, "patientId": "1", "providerId": "1", "signed": true, "startAfter": {}, "startBefore": {}, "updatedAtEnd": {}, "updatedAtStart": {}, "viewerOnly": true}Poll for a list of encounters updated since a specific datetime
| Argument | Type | Description |
|---|---|---|
updatedAtrequired | DateTime! | Updated at |
query($updatedAt: DateTime!) { encountersUpdatedSince(updatedAt: $updatedAt) { id # Add other fields you need }}{ "updatedAt": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { immunization(id: $id) { id # Add other fields you need }}{ "id": "1"}Get immunizations PDF
query( $ids: [ID], $isLatest: Boolean, $locationId: ID!, $patientId: ID!) { immunizationPdf( ids: $ids, isLatest: $isLatest, locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "ids": "1", "isLatest": true, "locationId": "1", "patientId": "1"}Get immunizations
| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
ids | [ID] | List of IDs |
ignoreHistorical | Boolean | Ignore historical |
isLatest | Boolean | Is latest |
isRabies | Boolean | Is rabies |
limit | Int | Maximum number of results to return |
locationId | ID | ID of the location |
offset | Int | Number of results to skip for pagination |
patientId | ID | ID of the patient |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $clientId: ID, $ids: [ID], $ignoreHistorical: Boolean, $isLatest: Boolean, $isRabies: Boolean, $limit: Int, $locationId: ID, $offset: Int, $patientId: ID, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { immunizations( clientId: $clientId, ids: $ids, ignoreHistorical: $ignoreHistorical, isLatest: $isLatest, isRabies: $isRabies, limit: $limit, locationId: $locationId, offset: $offset, patientId: $patientId, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "clientId": "1", "ids": "1", "ignoreHistorical": true, "isLatest": true, "isRabies": true, "limit": 1, "locationId": "1", "offset": 1, "patientId": "1", "updatedAtEnd": {}, "updatedAtStart": {}}query( $limit: Int, $locationId: ID!, $offset: Int, $showSilenced: Boolean, $withinDays: Int) { immunizationsDue( limit: $limit, locationId: $locationId, offset: $offset, showSilenced: $showSilenced, withinDays: $withinDays ) { id # Add other fields you need }}{ "limit": 1, "locationId": "1", "offset": 1, "showSilenced": true, "withinDays": 1}query( $limit: Int, $locationId: ID!, $offset: Int) { lapsingPatients( limit: $limit, locationId: $locationId, offset: $offset ) { id # Add other fields you need }}{ "limit": 1, "locationId": "1", "offset": 1}| Argument | Type | Description |
|---|---|---|
after | String | Cursor for forward pagination |
before | String | Cursor for backward pagination |
filters | EncounterFilters | Filters |
first | Int | First |
last | Int | Last |
orderBy | [EncounterOrderBy] | Order by |
query( $filters: EncounterFilters, $first: Int, $orderBy: [EncounterOrderBy]) { listEncounters( filters: $filters, first: $first, orderBy: $orderBy ) { edges { node { id # Add other fields you need } } pageInfo { hasNextPage endCursor } }}{ "filters": {}, "first": 1, "orderBy": {}}query($id: ID!) { macro(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
limit | Int | Maximum number of results to return |
locationIds | [ID] | List of location IDs |
name | String | Name of the resource |
offset | Int | Number of results to skip for pagination |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $limit: Int, $locationIds: [ID], $name: String, $offset: Int, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { macros( limit: $limit, locationIds: $locationIds, name: $name, offset: $offset, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "limit": 1, "locationIds": "1", "name": "example", "offset": 1, "updatedAtEnd": {}, "updatedAtStart": {}}query( $locationIds: [ID], $name: String) { macrosCount( locationIds: $locationIds, name: $name ) { id # Add other fields you need }}{ "locationIds": "1", "name": "example"}| Argument | Type | Description |
|---|---|---|
encounterIdrequired | ID! | ID of the clinical encounter |
query($encounterId: ID!) { mandatoryConsentForms(encounterId: $encounterId) { id # Add other fields you need }}{ "encounterId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { medication(id: $id) { id # Add other fields you need }}{ "id": "1"}Lookup a patient's medication by status
| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
hasRefills | Boolean | Has refills |
limit | Int | Maximum number of results to return |
locationId | ID | ID of the location |
offset | Int | Number of results to skip for pagination |
patientId | ID | ID of the patient |
status | MedicationStatus | Current status |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $clientId: ID, $hasRefills: Boolean, $limit: Int, $locationId: ID, $offset: Int, $patientId: ID, $status: MedicationStatus, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { medications( clientId: $clientId, hasRefills: $hasRefills, limit: $limit, locationId: $locationId, offset: $offset, patientId: $patientId, status: $status, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "clientId": "1", "hasRefills": true, "limit": 1, "locationId": "1", "offset": 1, "patientId": "1", "status": {}, "updatedAtEnd": {}, "updatedAtStart": {}}Retrieve the number of pending approval items in a patient’s orders
query( $locationId: ID!, $patientId: ID!) { ordersPendingApprovalCounts( locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "locationId": "1", "patientId": "1"}query($id: ID!) { patient(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { patientComplication(id: $id) { id # Add other fields you need }}{ "id": "1"}query( $clientId: ID, $patientId: ID!) { patientConsentForms( clientId: $clientId, patientId: $patientId ) { id # Add other fields you need }}{ "clientId": "1", "patientId": "1"}Get diagnostics for a specific patient
query( $first: Int, $locationId: ID!, $patientId: ID!, $status: [DiagnosticStatus]) { patientDiagnostics( first: $first, locationId: $locationId, patientId: $patientId, status: $status ) { edges { node { id # Add other fields you need } } pageInfo { hasNextPage endCursor } }}{ "first": 1, "locationId": "1", "patientId": "1", "status": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { patientDocument(id: $id) { id # Add other fields you need }}{ "id": "1"}Get encounter products for a specific patient
query( $first: Int, $locationId: ID!, $patientId: ID!, $status: [EncounterProductStatus]) { patientEncounterProducts( first: $first, locationId: $locationId, patientId: $patientId, status: $status ) { edges { node { id # Add other fields you need } } pageInfo { hasNextPage endCursor } }}{ "first": 1, "locationId": "1", "patientId": "1", "status": {}}query( $id: ID!, $locationId: ID!, $type: String) { patientLabel( id: $id, locationId: $locationId, type: $type ) { id # Add other fields you need }}{ "id": "1", "locationId": "1", "type": "example"}| Argument | Type | Description |
|---|---|---|
endDate | Date | End of date range |
endDueDate | Date | Final due date for the item |
limit | Int | Maximum number of results to return |
locationIds | [ID] | List of location IDs |
offset | Int | Number of results to skip for pagination |
orderBy | TriggeredProtocolsSortFieldEnum | Order by |
startDate | Date | Start of date range |
startDueDate | Date | Start due date |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $endDate: Date, $endDueDate: Date, $limit: Int, $locationIds: [ID], $offset: Int, $orderBy: TriggeredProtocolsSortFieldEnum, $startDate: Date, $startDueDate: Date, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { patientProtocols( endDate: $endDate, endDueDate: $endDueDate, limit: $limit, locationIds: $locationIds, offset: $offset, orderBy: $orderBy, startDate: $startDate, startDueDate: $startDueDate, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "endDate": {}, "endDueDate": {}, "limit": 1, "locationIds": "1", "offset": 1, "orderBy": {}, "startDate": {}, "startDueDate": {}, "updatedAtEnd": {}, "updatedAtStart": {}}query($id: ID!) { patientQrCode(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { patientTag(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { patientTags( updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "updatedAtEnd": {}, "updatedAtStart": {}}Get treatments for a specific patient
query( $first: Int, $locationId: ID!, $patientId: ID!, $status: [TreatmentStatus]) { patientTreatments( first: $first, locationId: $locationId, patientId: $patientId, status: $status ) { edges { node { id # Add other fields you need } } pageInfo { hasNextPage endCursor } }}{ "first": 1, "locationId": "1", "patientId": "1", "status": {}}Retrieve a list of all patients at your org
| Argument | Type | Description |
|---|---|---|
filters | PatientFilters | Filter the patients return by field |
limit | Int | Limit the number of results (defaults to nil) |
offset | Int | For pagination, offset the return values by a number (defaults to 0 / no offset) |
orderBy | PatientOrderByEnum | Field to order the results by (e.g., 'name', 'created_at'). Default is 'id'. |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $filters: PatientFilters, $limit: Int, $offset: Int, $orderBy: PatientOrderByEnum, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { patients( filters: $filters, limit: $limit, offset: $offset, orderBy: $orderBy, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "filters": {}, "limit": 1, "offset": 1, "orderBy": {}, "updatedAtEnd": {}, "updatedAtStart": {}}Retrieve paginated medications with pharmacy statuses
| Argument | Type | Description |
|---|---|---|
after | String | Cursor for forward pagination |
before | String | Cursor for backward pagination |
first | Int | First |
last | Int | Last |
orderBy | [PharmacyMedicationsOrderBy] | Order by |
pharmacyStatus | [PharmacyStatus] | Filter by specific pharmacy statuses |
searchTerm | String | Search by patient name, client name, drug name, drug code, or RX number |
status | [MedicationStatus] | Filter by specific pharmacy statuses |
query( $first: Int, $orderBy: [PharmacyMedicationsOrderBy], $pharmacyStatus: [PharmacyStatus], $searchTerm: String, $status: [MedicationStatus]) { pharmacyMedications( first: $first, orderBy: $orderBy, pharmacyStatus: $pharmacyStatus, searchTerm: $searchTerm, status: $status ) { edges { node { id # Add other fields you need } } pageInfo { hasNextPage endCursor } }}{ "first": 1, "orderBy": {}, "pharmacyStatus": {}, "searchTerm": "example", "status": {}}Get count of medications grouped by pharmacy status
query { pharmacyMedicationsCount { id # Add other fields you need }}| Argument | Type | Description |
|---|---|---|
limit | Int | Maximum number of results to return |
offset | Int | Number of results to skip for pagination |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $limit: Int, $offset: Int, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { problems( limit: $limit, offset: $offset, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "limit": 1, "offset": 1, "updatedAtEnd": {}, "updatedAtStart": {}}query( $ignoreHistorical: Boolean, $locationId: ID, $patientId: ID!) { rabiesCertificate( ignoreHistorical: $ignoreHistorical, locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "ignoreHistorical": true, "locationId": "1", "patientId": "1"}query( $ids: [ID!], $locationId: ID, $patientId: ID!) { rabiesCertificates( ids: $ids, locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "ids": {}, "locationId": "1", "patientId": "1"}Search diagnoses by term
query( $limit: Int!, $term: String!) { searchDiagnoses( limit: $limit, term: $term ) { id # Add other fields you need }}{ "limit": 1, "term": "example"}query( $limit: Int, $locationId: ID, $term: String!) { searchMacros( limit: $limit, locationId: $locationId, term: $term ) { id # Add other fields you need }}{ "limit": 1, "locationId": "1", "term": "example"}query { totalPatients { id # Add other fields you need }}| Argument | Type | Description |
|---|---|---|
clientId | ID | ID of the client (pet owner) |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $clientId: ID, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { treatments( clientId: $clientId, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "clientId": "1", "updatedAtEnd": {}, "updatedAtStart": {}}query($id: ID!) { visit(id: $id) { id # Add other fields you need }}{ "id": "1"}Historical vitals
| Argument | Type | Description |
|---|---|---|
appointmentId | ID | ID of the appointment |
encounterId | ID | ID of the clinical encounter |
from | DateTime | From |
limit | Int | Maximum number of results to return |
offset | Int | Number of results to skip for pagination |
patientId | ID | ID of the patient |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $appointmentId: ID, $encounterId: ID, $from: DateTime, $limit: Int, $offset: Int, $patientId: ID, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { vitals( appointmentId: $appointmentId, encounterId: $encounterId, from: $from, limit: $limit, offset: $offset, patientId: $patientId, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "appointmentId": "1", "encounterId": "1", "from": {}, "limit": 1, "offset": 1, "patientId": "1", "updatedAtEnd": {}, "updatedAtStart": {}}Format for vitals
| Argument | Type | Description |
|---|---|---|
appointmentId | ID | ID of the appointment |
query($appointmentId: ID) { vitalsTemplate(appointmentId: $appointmentId) { id # Add other fields you need }}{ "appointmentId": "1"}