Clinical Queries

Interactive examples coming soon...

allergies :: [Allergy]

Argument	Type	Description
patientId	ID!

complication :: Complication

Argument	Type	Description
id	ID!	ID of resource to lookup

complications :: [Complication!]!

Argument	Type	Description
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

dashboard :: Dashboard

No arguments.

diagnostics :: [Diagnostic]

Argument	Type	Description
clientId	ID
patientId	ID
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

encounter :: Encounter

Argument	Type	Description
id	ID!

encounterProducts :: [EncounterProduct]

Argument	Type	Description
clientId	ID
limit	Int
locationId	ID
offset	Int
patientId	ID
providerId	ID
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

encounterSummary :: String

Argument	Type	Description
attachmentIds	[ID]
documentType	EncounterSummaryDocumentType
encounterId	ID!
extras	[String]
locationId	ID
only	[String]
onlySections	[String]

encounterTypes :: [EncounterType]

Argument	Type	Description
isEmbeddable	Boolean
locationId	ID
onlyEnabled	Boolean

encounters :: [Encounter]

Search for encounters by patient id, org id, and status

Argument	Type	Description
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

encountersUpdatedSince :: [Encounter]

Poll for a list of encounters updated since a specific datetime

Argument	Type	Description
updatedAt	DateTime!

immunization :: Immunization

Argument	Type	Description
id	ID!	ID of resource to lookup

immunizationPdf :: String

Get immunizations PDF

Argument	Type	Description
ids	[ID]
isLatest	Boolean
locationId	ID!
patientId	ID!

immunizations :: [Immunization]

Get immunizations

Argument	Type	Description
clientId	ID
ids	[ID]
ignoreHistorical	Boolean
isLatest	Boolean
isRabies	Boolean
limit	Int
locationId	ID
offset	Int
patientId	ID
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

immunizationsDue :: [Immunization]

Argument	Type	Description
limit	Int
locationId	ID!
offset	Int
showSilenced	Boolean
withinDays	Int

lapsingPatients :: [Patient]

Argument	Type	Description
limit	Int
locationId	ID!
offset	Int

listEncounters :: EncounterConnection

Argument	Type	Description
after	String
before	String
filters	EncounterFilters
first	Int
last	Int
orderBy	[EncounterOrderBy]

macro :: Macro

Argument	Type	Description
id	ID!	ID of resource to lookup

macros :: [Macro]!

Argument	Type	Description
limit	Int
locationIds	[ID]
name	String
offset	Int
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

macrosCount :: Int

Argument	Type	Description
locationIds	[ID]
name	String

mandatoryConsentForms :: [String]

Argument	Type	Description
encounterId	ID!

medication :: Medication

Argument	Type	Description
id	ID!	ID of resource to lookup

medications :: [Medication]

Lookup a patient's medication by status

Argument	Type	Description
clientId	ID
hasRefills	Boolean
limit	Int
locationId	ID
offset	Int
patientId	ID
status	MedicationStatus
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

ordersPendingApprovalCounts :: OrdersCounts

Retrieve the number of pending approval items in a patient’s orders

Argument	Type	Description
locationId	ID!
patientId	ID!

patient :: Patient

Argument	Type	Description
id	ID!	ID of resource to lookup

patientComplication :: PatientComplication

Argument	Type	Description
id	ID!	ID of resource to lookup

patientConsentForms :: [ClientConsent]

Argument	Type	Description
clientId	ID
patientId	ID!

patientDiagnostics :: DiagnosticConnection

Get diagnostics for a specific patient

Argument	Type	Description
after	String
before	String
first	Int
last	Int
locationId	ID!
patientId	ID!
status	[DiagnosticStatus]

patientDocument :: PatientDocument

Argument	Type	Description
id	ID!	ID of resource to lookup

patientEncounterProducts :: EncounterProductConnection

Get encounter products for a specific patient

Argument	Type	Description
after	String
before	String
first	Int
last	Int
locationId	ID!
patientId	ID!
status	[EncounterProductStatus]

patientLabel :: String

Argument	Type	Description
id	ID!
locationId	ID!
type	String

patientProtocols :: [PatientProtocol]

Argument	Type	Description
endDate	Date
endDueDate	Date
limit	Int
locationIds	[ID]
offset	Int
orderBy	TriggeredProtocolsSortFieldEnum
startDate	Date
startDueDate	Date
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

patientQrCode :: String

Argument	Type	Description
id	ID!

patientTag :: PatientTag

Argument	Type	Description
id	ID!	ID of resource to lookup

patientTags :: [PatientTag!]!

Argument	Type	Description
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

patientTreatments :: TreatmentConnection

Get treatments for a specific patient

Argument	Type	Description
after	String
before	String
first	Int
last	Int
locationId	ID!
patientId	ID!
status	[TreatmentStatus]

patients :: [Patient!]!

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
updatedAtStart	NaiveDateTime

pharmacyMedications :: MedicationConnection

Retrieve paginated medications with pharmacy statuses

Argument	Type	Description
after	String
before	String
first	Int
last	Int
orderBy	[PharmacyMedicationsOrderBy]
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

pharmacyMedicationsCount :: [MedicationStatusCount]!

Get count of medications grouped by pharmacy status

No arguments.

problems :: [Problem]

Argument	Type	Description
limit	Int
offset	Int
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

rabiesCertificate :: String

Argument	Type	Description
ignoreHistorical	Boolean
locationId	ID
patientId	ID!

rabiesCertificates :: [String]

Argument	Type	Description
ids	[ID!]
locationId	ID
patientId	ID!

searchDiagnoses :: [Diagnosis]

Search diagnoses by term

Argument	Type	Description
limit	Int!
term	String!

searchMacros :: [Macro]

Argument	Type	Description
limit	Int
locationId	ID
term	String!

totalPatients :: Int

No arguments.

treatments :: [Treatment]

Argument	Type	Description
clientId	ID
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

visit :: Visit

Argument	Type	Description
id	ID!	ID of resource to lookup

vitals :: [Vitals]

Historical vitals

Argument	Type	Description
appointmentId	ID
encounterId	ID
from	DateTime
limit	Int
offset	Int
patientId	ID
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

vitalsTemplate :: [VitalDatum]

Format for vitals

Argument	Type	Description
appointmentId	ID