Entities Queries

These queries allow you to interact with entities data.

alert

Returns: Alert

Arguments

ArgumentTypeDescription
idrequiredID!ID of resource to lookup
Example Query
query($id: ID!) {
alert(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

alerts

Returns: [Alert!]!

Arguments

ArgumentTypeDescription
updatedAtEndNaiveDateTimeUpdated at end
updatedAtStartNaiveDateTimeUpdated at start
Example Query
query(
$updatedAtEnd: NaiveDateTime,
$updatedAtStart: NaiveDateTime
) {
alerts(
updatedAtEnd: $updatedAtEnd,
updatedAtStart: $updatedAtStart
) {
id
# Add other fields you need
}
}
Variables
{
"updatedAtEnd": {},
"updatedAtStart": {}
}

cages

Returns: [Cage]

Arguments

ArgumentTypeDescription
locationIdIDID of the location
patientIdIDID of the patient
Example Query
query(
$locationId: ID,
$patientId: ID
) {
cages(
locationId: $locationId,
patientId: $patientId
) {
id
# Add other fields you need
}
}
Variables
{
"locationId": "1",
"patientId": "1"
}

clientReferralSource

Arguments

ArgumentTypeDescription
idrequiredID!ID of resource to lookup
Example Query
query($id: ID!) {
clientReferralSource(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

clientReferralSources

Arguments

ArgumentTypeDescription
updatedAtEndNaiveDateTimeUpdated at end
updatedAtStartNaiveDateTimeUpdated at start
Example Query
query(
$updatedAtEnd: NaiveDateTime,
$updatedAtStart: NaiveDateTime
) {
clientReferralSources(
updatedAtEnd: $updatedAtEnd,
updatedAtStart: $updatedAtStart
) {
id
# Add other fields you need
}
}
Variables
{
"updatedAtEnd": {},
"updatedAtStart": {}
}

consentForm

Returns: ConsentForm

The `should_convert_urls_to_a_tags` is a boolean flag that determines whether URLs should be converted into clickable links by adding an <a> tag with the CSS class `vespire-consent-form-link`.

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
shouldConvertUrlsToATagsBooleanShould convert urls to a tags
Example Query
query(
$id: ID!,
$shouldConvertUrlsToATags: Boolean
) {
consentForm(
id: $id,
shouldConvertUrlsToATags: $shouldConvertUrlsToATags
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"shouldConvertUrlsToATags": true
}

consentForms

Returns: [ConsentForm]

Arguments

ArgumentTypeDescription
onlyEnabledBooleanReturn only enabled items
Example Query
query($onlyEnabled: Boolean) {
consentForms(onlyEnabled: $onlyEnabled) {
id
# Add other fields you need
}
}
Variables
{
"onlyEnabled": true
}

departments

Returns: [Department]

Arguments

ArgumentTypeDescription
locationIdrequiredID!ID of the location
Example Query
query($locationId: ID!) {
departments(locationId: $locationId) {
id
# Add other fields you need
}
}
Variables
{
"locationId": "1"
}

encounterType

Returns: EncounterType

Arguments

ArgumentTypeDescription
idrequiredID!ID of resource to lookup
Example Query
query($id: ID!) {
encounterType(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

entityValidations

Returns: [EntityValidation!]!

Arguments

ArgumentTypeDescription
updatedAtEndNaiveDateTimeUpdated at end
updatedAtStartNaiveDateTimeUpdated at start
Example Query
query(
$updatedAtEnd: NaiveDateTime,
$updatedAtStart: NaiveDateTime
) {
entityValidations(
updatedAtEnd: $updatedAtEnd,
updatedAtStart: $updatedAtStart
) {
id
# Add other fields you need
}
}
Variables
{
"updatedAtEnd": {},
"updatedAtStart": {}
}

fileFolders

Returns: [String!]!
Example Query
query {
fileFolders {
id
# Add other fields you need
}
}

files

Returns: FileResults!

Arguments

ArgumentTypeDescription
pageTokenStringPage token
pathrequiredString!Path
Example Query
query(
$pageToken: String,
$path: String!
) {
files(
pageToken: $pageToken,
path: $path
) {
id
# Add other fields you need
}
}
Variables
{
"pageToken": "example",
"path": "example"
}

isDaycareOpen

Returns: Boolean

Arguments

ArgumentTypeDescription
daterequiredDate!Specific date for the query
locationIdrequiredID!ID of the location
Example Query
query(
$date: Date!,
$locationId: ID!
) {
isDaycareOpen(
date: $date,
locationId: $locationId
) {
id
# Add other fields you need
}
}
Variables
{
"date": {},
"locationId": "1"
}

legalEntities

Returns: [LegalEntity]
Example Query
query {
legalEntities {
id
# Add other fields you need
}
}

location

Returns: Location

Lookup a location by id (defaults to latest added)

Arguments

ArgumentTypeDescription
idIDUnique identifier
Example Query
query($id: ID) {
location(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

locationChatMessages

Arguments

ArgumentTypeDescription
limitIntMaximum number of results to return
locationIdrequiredID!ID of the location
offsetIntNumber of results to skip for pagination
Example Query
query(
$limit: Int,
$locationId: ID!,
$offset: Int
) {
locationChatMessages(
limit: $limit,
locationId: $locationId,
offset: $offset
) {
id
# Add other fields you need
}
}
Variables
{
"limit": 1,
"locationId": "1",
"offset": 1
}

locationTag

Returns: LocationTag

Arguments

ArgumentTypeDescription
idrequiredID!ID of resource to lookup
Example Query
query($id: ID!) {
locationTag(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

locationTags

Returns: [LocationTag!]!

Arguments

ArgumentTypeDescription
updatedAtEndNaiveDateTimeUpdated at end
updatedAtStartNaiveDateTimeUpdated at start
Example Query
query(
$updatedAtEnd: NaiveDateTime,
$updatedAtStart: NaiveDateTime
) {
locationTags(
updatedAtEnd: $updatedAtEnd,
updatedAtStart: $updatedAtStart
) {
id
# Add other fields you need
}
}
Variables
{
"updatedAtEnd": {},
"updatedAtStart": {}
}

locations

Returns: [Location!]

Arguments

ArgumentTypeDescription
filtersLocationFiltersFilters
limitIntMaximum number of results to return
offsetIntNumber of results to skip for pagination
viewerAssignedOnlyBooleanViewer assigned only
Example Query
query(
$filters: LocationFilters,
$limit: Int,
$offset: Int,
$viewerAssignedOnly: Boolean
) {
locations(
filters: $filters,
limit: $limit,
offset: $offset,
viewerAssignedOnly: $viewerAssignedOnly
) {
id
# Add other fields you need
}
}
Variables
{
"filters": {},
"limit": 1,
"offset": 1,
"viewerAssignedOnly": true
}

locationsDepartments

Returns: [Department]

Arguments

ArgumentTypeDescription
locationIds[ID]List of location IDs
Example Query
query($locationIds: [ID]) {
locationsDepartments(locationIds: $locationIds) {
id
# Add other fields you need
}
}
Variables
{
"locationIds": "1"
}

org

Returns: Org

Lookup an org (defaults to viewer's)

Example Query
query {
org {
id
# Add other fields you need
}
}

orgDepartments

Returns: [OrgDepartment]
Example Query
query {
orgDepartments {
id
# Add other fields you need
}
}

providerDepartments

Returns: [Department]

Arguments

ArgumentTypeDescription
locationIds[ID]List of location IDs
providerIdrequiredID!ID of the provider
Example Query
query(
$locationIds: [ID],
$providerId: ID!
) {
providerDepartments(
locationIds: $locationIds,
providerId: $providerId
) {
id
# Add other fields you need
}
}
Variables
{
"locationIds": "1",
"providerId": "1"
}

searchLocationTags

Returns: [String]

Arguments

ArgumentTypeDescription
namerequiredString!Name of the resource
Example Query
query($name: String!) {
searchLocationTags(name: $name) {
id
# Add other fields you need
}
}
Variables
{
"name": "example"
}

searchPrintnodeComputers

Search for the computers associated with PrintNode account

Example Query
query {
searchPrintnodeComputers {
id
# Add other fields you need
}
}

searchPrintnodePrinters

Search for the printers associated with PrintNode account

Arguments

ArgumentTypeDescription
locationIdrequiredID!ID of the location
Example Query
query($locationId: ID!) {
searchPrintnodePrinters(locationId: $locationId) {
id
# Add other fields you need
}
}
Variables
{
"locationId": "1"
}